com.liferay.portlet.social.service
Class SocialActivitySettingLocalServiceUtil

java.lang.Object
  com.liferay.portlet.social.service.SocialActivitySettingLocalServiceUtil

public class SocialActivitySettingLocalServiceUtil
extends Object

The utility for the social activity setting local service. This utility wraps com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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.

See Also:

SocialActivitySettingLocalService, com.liferay.portlet.social.service.base.SocialActivitySettingLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl

Constructor Summary

SocialActivitySettingLocalServiceUtil()

Method Summary

static SocialActivitySetting	addSocialActivitySetting(SocialActivitySetting socialActivitySetting) Adds the social activity setting to the database.
static SocialActivitySetting	createSocialActivitySetting(long activitySettingId) Creates a new social activity setting with the primary key.
static SocialActivitySetting	deleteSocialActivitySetting(long activitySettingId) Deletes the social activity setting with the primary key from the database.
static SocialActivitySetting	deleteSocialActivitySetting(SocialActivitySetting socialActivitySetting) Deletes the social activity setting from the database.
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static SocialActivitySetting	fetchSocialActivitySetting(long activitySettingId)
static SocialActivityDefinition	getActivityDefinition(long groupId, String className, int activityType)
static List<SocialActivityDefinition>	getActivityDefinitions(long groupId, String className)
static List<SocialActivitySetting>	getActivitySettings(long groupId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static SocialActivitySettingLocalService	getService()
static SocialActivitySetting	getSocialActivitySetting(long activitySettingId) Returns the social activity setting with the primary key.
static List<SocialActivitySetting>	getSocialActivitySettings(int start, int end) Returns a range of all the social activity settings.
static int	getSocialActivitySettingsCount() Returns the number of social activity settings.
static boolean	isEnabled(long groupId, long classNameId)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(SocialActivitySettingLocalService service) Deprecated.
static void	updateActivitySetting(long groupId, String className, boolean enabled)
static void	updateActivitySetting(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition)
static void	updateActivitySettings(long groupId, String className, int activityType, List<SocialActivityCounterDefinition> activityCounterDefinitions)
static SocialActivitySetting	updateSocialActivitySetting(SocialActivitySetting socialActivitySetting) Updates the social activity setting in the database or adds it if it does not yet exist.
static SocialActivitySetting	updateSocialActivitySetting(SocialActivitySetting socialActivitySetting, boolean merge) Updates the social activity setting in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocialActivitySettingLocalServiceUtil

public SocialActivitySettingLocalServiceUtil()

Method Detail

addSocialActivitySetting

public static SocialActivitySetting addSocialActivitySetting(SocialActivitySetting socialActivitySetting)
                                                      throws SystemException

Adds the social activity setting to the database. Also notifies the appropriate model listeners.

Parameters:

socialActivitySetting - the social activity setting

Returns:

the social activity setting that was added

Throws:

SystemException - if a system exception occurred

createSocialActivitySetting

public static SocialActivitySetting createSocialActivitySetting(long activitySettingId)

Creates a new social activity setting with the primary key. Does not add the social activity setting to the database.

Parameters:

activitySettingId - the primary key for the new social activity setting

Returns:

the new social activity setting

deleteSocialActivitySetting

public static SocialActivitySetting deleteSocialActivitySetting(long activitySettingId)
                                                         throws PortalException,
                                                                SystemException

Deletes the social activity setting with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

activitySettingId - the primary key of the social activity setting

Returns:

the social activity setting that was removed

Throws:

PortalException - if a social activity setting with the primary key could not be found

SystemException - if a system exception occurred

deleteSocialActivitySetting

public static SocialActivitySetting deleteSocialActivitySetting(SocialActivitySetting socialActivitySetting)
                                                         throws SystemException

Deletes the social activity setting from the database. Also notifies the appropriate model listeners.

Parameters:

socialActivitySetting - the social activity setting

Returns:

the social activity setting that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchSocialActivitySetting

public static SocialActivitySetting fetchSocialActivitySetting(long activitySettingId)
                                                        throws SystemException

Throws:

SystemException

getSocialActivitySetting

public static SocialActivitySetting getSocialActivitySetting(long activitySettingId)
                                                      throws PortalException,
                                                             SystemException

Returns the social activity setting with the primary key.

Parameters:

activitySettingId - the primary key of the social activity setting

Returns:

the social activity setting

Throws:

PortalException - if a social activity setting with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getSocialActivitySettings

public static List<SocialActivitySetting> getSocialActivitySettings(int start,
                                                                    int end)
                                                             throws SystemException

Returns a range of all the social activity settings.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of social activity settings

end - the upper bound of the range of social activity settings (not inclusive)

Returns:

the range of social activity settings

Throws:

SystemException - if a system exception occurred

getSocialActivitySettingsCount

public static int getSocialActivitySettingsCount()
                                          throws SystemException

Returns the number of social activity settings.

Returns:

the number of social activity settings

Throws:

SystemException - if a system exception occurred

updateSocialActivitySetting

public static SocialActivitySetting updateSocialActivitySetting(SocialActivitySetting socialActivitySetting)
                                                         throws SystemException

Updates the social activity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

socialActivitySetting - the social activity setting

Returns:

the social activity setting that was updated

Throws:

SystemException - if a system exception occurred

updateSocialActivitySetting

public static SocialActivitySetting updateSocialActivitySetting(SocialActivitySetting socialActivitySetting,
                                                                boolean merge)
                                                         throws SystemException

Updates the social activity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

socialActivitySetting - the social activity setting

merge - whether to merge the social activity setting with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the social activity setting that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

getActivityDefinition

public static SocialActivityDefinition getActivityDefinition(long groupId,
                                                             String className,
                                                             int activityType)
                                                      throws SystemException

Throws:

SystemException

getActivityDefinitions

public static List<SocialActivityDefinition> getActivityDefinitions(long groupId,
                                                                    String className)
                                                             throws SystemException

Throws:

SystemException

getActivitySettings

public static List<SocialActivitySetting> getActivitySettings(long groupId)
                                                       throws SystemException

Throws:

SystemException

isEnabled

public static boolean isEnabled(long groupId,
                                long classNameId)
                         throws SystemException

Throws:

SystemException

updateActivitySetting

public static void updateActivitySetting(long groupId,
                                         String className,
                                         boolean enabled)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

updateActivitySetting

public static void updateActivitySetting(long groupId,
                                         String className,
                                         int activityType,
                                         SocialActivityCounterDefinition activityCounterDefinition)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

updateActivitySettings

public static void updateActivitySettings(long groupId,
                                          String className,
                                          int activityType,
                                          List<SocialActivityCounterDefinition> activityCounterDefinitions)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getService

public static SocialActivitySettingLocalService getService()

setService

public void setService(SocialActivitySettingLocalService service)

Deprecated.