001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.social.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Transactional;
021    import com.liferay.portal.service.BaseLocalService;
022    
023    /**
024     * The interface for the social activity interpreter local service.
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see SocialActivityInterpreterLocalServiceUtil
032     * @see com.liferay.portlet.social.service.base.SocialActivityInterpreterLocalServiceBaseImpl
033     * @see com.liferay.portlet.social.service.impl.SocialActivityInterpreterLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface SocialActivityInterpreterLocalService extends BaseLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * Never modify or reference this interface directly. Always use {@link SocialActivityInterpreterLocalServiceUtil} to access the social activity interpreter local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivityInterpreterLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
043             */
044    
045            /**
046            * Returns the Spring bean ID for this bean.
047            *
048            * @return the Spring bean ID for this bean
049            */
050            public java.lang.String getBeanIdentifier();
051    
052            /**
053            * Sets the Spring bean ID for this bean.
054            *
055            * @param beanIdentifier the Spring bean ID for this bean
056            */
057            public void setBeanIdentifier(java.lang.String beanIdentifier);
058    
059            /**
060            * Adds the activity interpreter to the list of available interpreters.
061            *
062            * @param activityInterpreter the activity interpreter
063            */
064            public void addActivityInterpreter(
065                    com.liferay.portlet.social.model.SocialActivityInterpreter activityInterpreter);
066    
067            /**
068            * Removes the activity interpreter from the list of available interpreters.
069            *
070            * @param activityInterpreter the activity interpreter
071            */
072            public void deleteActivityInterpreter(
073                    com.liferay.portlet.social.model.SocialActivityInterpreter activityInterpreter);
074    
075            /**
076            * Creates a human readable activity feed entry for the activity using an
077            * available compatible activity interpreter.
078            *
079            * <p>
080            * This method finds the appropriate interpreter for the activity by going
081            * through the available interpreters and asking them if they can handle the
082            * asset type of the activity.
083            * </p>
084            *
085            * @param activity the activity to be translated to human readable form
086            * @param themeDisplay the theme display needed by interpreters to create
087            links and get localized text fragments
088            * @return the activity feed that is a human readable form of the activity
089            record or <code>null</code> if a compatible interpreter is not
090            found
091            */
092            public com.liferay.portlet.social.model.SocialActivityFeedEntry interpret(
093                    com.liferay.portlet.social.model.SocialActivity activity,
094                    com.liferay.portal.theme.ThemeDisplay themeDisplay);
095    }