com.liferay.portlet.social.service
Interface SocialActivitySettingLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SocialActivitySettingLocalServiceWrapper

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

The interface for the social activity setting local service.

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:

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

Method Summary

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.
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()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
SocialActivitySetting	fetchSocialActivitySetting(long activitySettingId)
SocialActivityDefinition	getActivityDefinition(long groupId, String className, int activityType)
List<SocialActivityDefinition>	getActivityDefinitions(long groupId, String className)
List<SocialActivitySetting>	getActivitySettings(long groupId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	updateActivitySetting(long groupId, String className, boolean enabled)
void	updateActivitySetting(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition)
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.
SocialActivitySetting	updateSocialActivitySetting(SocialActivitySetting socialActivitySetting, boolean merge) Updates the social activity setting in the database or adds it if it does not yet exist.

Method Detail

addSocialActivitySetting

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

Throws:

SystemException

getSocialActivitySetting

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

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getSocialActivitySettings

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

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

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

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

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

getActivityDefinition

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

Throws:

SystemException

getActivityDefinitions

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

Throws:

SystemException

getActivitySettings

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

Throws:

SystemException

isEnabled

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

Throws:

SystemException

updateActivitySetting

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

Throws:

PortalException

SystemException

updateActivitySetting

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

Throws:

PortalException

SystemException

updateActivitySettings

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

Throws:

PortalException

SystemException