com.liferay.social.kernel.service

Interface SocialActivitySettingLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SocialActivitySettingLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SocialActivitySettingLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for SocialActivitySetting. 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:

SocialActivitySettingLocalServiceUtil, SocialActivitySettingLocalServiceBaseImpl, SocialActivitySettingLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
SocialActivitySetting	addSocialActivitySetting(SocialActivitySetting socialActivitySetting) Adds the social activity setting to the database.
SocialActivitySetting	createSocialActivitySetting(long activitySettingId) Creates a new social activity setting with the primary key.
void	deleteActivitySetting(long groupId, String className, long classPK)
void	deleteActivitySettings(long groupId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
SocialActivitySetting	deleteSocialActivitySetting(long activitySettingId) Deletes the social activity setting with the primary key from the database.
SocialActivitySetting	deleteSocialActivitySetting(SocialActivitySetting socialActivitySetting) Deletes the social activity setting from the database.
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
SocialActivitySetting	fetchSocialActivitySetting(long activitySettingId)
ActionableDynamicQuery	getActionableDynamicQuery()
SocialActivityDefinition	getActivityDefinition(long groupId, String className, int activityType)
List<SocialActivityDefinition>	getActivityDefinitions(long groupId, String className)
List<SocialActivitySetting>	getActivitySettings(long groupId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
SocialActivitySetting	getSocialActivitySetting(long activitySettingId) Returns the social activity setting with the primary key.
List<SocialActivitySetting>	getSocialActivitySettings(int start, int end) Returns a range of all the social activity settings.
int	getSocialActivitySettingsCount() Returns the number of social activity settings.
boolean	isEnabled(long groupId, long classNameId)
boolean	isEnabled(long groupId, long classNameId, long classPK)
void	updateActivitySetting(long groupId, String className, boolean enabled)
void	updateActivitySetting(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition)
void	updateActivitySetting(long groupId, String className, long classPK, boolean enabled)
void	updateActivitySettings(long groupId, String className, int activityType, List<SocialActivityCounterDefinition> activityCounterDefinitions)
SocialActivitySetting	updateSocialActivitySetting(SocialActivitySetting socialActivitySetting) Updates the social activity setting in the database or adds it if it does not yet exist.

Method Detail

addSocialActivitySetting

@Indexable(type=REINDEX)
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

@Transactional(enabled=false)
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

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

deleteActivitySettings

void deleteActivitySettings(long groupId)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSocialActivitySetting

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivitySetting fetchSocialActivitySetting(long activitySettingId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getActivityDefinition

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivityDefinition getActivityDefinition(long groupId,
                                                                                                                  String className,
                                                                                                                  int activityType)

getActivityDefinitions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivityDefinition> getActivityDefinitions(long groupId,
                                                                                                                         String className)

getActivitySettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivitySetting> getActivitySettings(long groupId)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSocialActivitySetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSocialActivitySettingsCount()

Returns the number of social activity settings.

Returns:

the number of social activity settings

isEnabled

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isEnabled(long groupId,
                                                                                     long classNameId)

isEnabled

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isEnabled(long groupId,
                                                                                     long classNameId,
                                                                                     long classPK)

updateActivitySetting

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

Throws:

PortalException

updateActivitySetting

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

Throws:

PortalException

updateActivitySetting

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

Throws:

PortalException

updateActivitySettings

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

Throws:

PortalException

updateSocialActivitySetting

@Indexable(type=REINDEX)
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