com.liferay.social.kernel.service

Class SocialActivitySettingLocalServiceUtil

Object

com.liferay.social.kernel.service.SocialActivitySettingLocalServiceUtil

public class SocialActivitySettingLocalServiceUtil
extends Object

Provides the local service utility for SocialActivitySetting. This utility wraps com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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.

Author:

Brian Wing Shun Chan

See Also:

SocialActivitySettingLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
SocialActivitySettingLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
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 void	deleteActivitySetting(long groupId, String className, long classPK)
static void	deleteActivitySettings(long groupId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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 <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static SocialActivitySetting	fetchSocialActivitySetting(long activitySettingId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static SocialActivityDefinition	getActivityDefinition(long groupId, String className, int activityType)
static List<SocialActivityDefinition>	getActivityDefinitions(long groupId, String className)
static List<SocialActivitySetting>	getActivitySettings(long groupId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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 boolean	isEnabled(long groupId, long classNameId, long classPK)
static void	updateActivitySetting(long groupId, String className, boolean enabled)
static void	updateActivitySetting(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition)
static void	updateActivitySetting(long groupId, String className, long classPK, boolean enabled)
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.

Methods inherited from class 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)

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

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

deleteActivitySetting

public static void deleteActivitySetting(long groupId,
                                         String className,
                                         long classPK)

deleteActivitySettings

public static void deleteActivitySettings(long groupId)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteSocialActivitySetting

public static SocialActivitySetting deleteSocialActivitySetting(long activitySettingId)
                                                         throws PortalException

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

deleteSocialActivitySetting

public static SocialActivitySetting deleteSocialActivitySetting(SocialActivitySetting socialActivitySetting)

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

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchSocialActivitySetting

public static SocialActivitySetting fetchSocialActivitySetting(long activitySettingId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getActivityDefinition

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

getActivityDefinitions

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

getActivitySettings

public static List<SocialActivitySetting> getActivitySettings(long groupId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getSocialActivitySetting

public static SocialActivitySetting getSocialActivitySetting(long activitySettingId)
                                                      throws PortalException

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

getSocialActivitySettings

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

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getSocialActivitySettingsCount

public static int getSocialActivitySettingsCount()

Returns the number of social activity settings.

Returns:

the number of social activity settings

isEnabled

public static boolean isEnabled(long groupId,
                                long classNameId)

isEnabled

public static boolean isEnabled(long groupId,
                                long classNameId,
                                long classPK)

updateActivitySetting

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

Throws:

PortalException

updateActivitySetting

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

Throws:

PortalException

updateActivitySetting

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

Throws:

PortalException

updateActivitySettings

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

Throws:

PortalException

updateSocialActivitySetting

public static SocialActivitySetting updateSocialActivitySetting(SocialActivitySetting socialActivitySetting)

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

getService

public static SocialActivitySettingLocalService getService()