Liferay 6.1.0

com.liferay.portlet.social.service
Interface SocialEquitySettingLocalService

All Superinterfaces:
PersistedModelLocalService
All Known Implementing Classes:
SocialEquitySettingLocalServiceWrapper

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

The interface for the social equity 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:
SocialEquitySettingLocalServiceUtil, com.liferay.portlet.social.service.base.SocialEquitySettingLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialEquitySettingLocalServiceImpl

Method Summary
 SocialEquitySetting addSocialEquitySetting(SocialEquitySetting socialEquitySetting)
          Adds the social equity setting to the database.
 SocialEquitySetting createSocialEquitySetting(long equitySettingId)
          Creates a new social equity setting with the primary key.
 void deleteSocialEquitySetting(long equitySettingId)
          Deletes the social equity setting with the primary key from the database.
 void deleteSocialEquitySetting(SocialEquitySetting socialEquitySetting)
          Deletes the social equity setting from the database.
 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.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<SocialEquitySetting> getEquitySettings(long groupId, long classNameId, String actionId)
          Returns all the settings for the social equity action.
 List<SocialEquitySetting> getEquitySettings(long groupId, String className, String actionId)
          Returns all the settings for the social equity action.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 SocialEquitySetting getSocialEquitySetting(long equitySettingId)
          Returns the social equity setting with the primary key.
 List<SocialEquitySetting> getSocialEquitySettings(int start, int end)
          Returns a range of all the social equity settings.
 int getSocialEquitySettingsCount()
          Returns the number of social equity settings.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void updateEquitySettings(long groupId, String className, List<SocialEquityActionMapping> equityActionMappings)
          Updates settings for the model (asset type) in the group.
 SocialEquitySetting updateSocialEquitySetting(SocialEquitySetting socialEquitySetting)
          Updates the social equity setting in the database or adds it if it does not yet exist.
 SocialEquitySetting updateSocialEquitySetting(SocialEquitySetting socialEquitySetting, boolean merge)
          Updates the social equity setting in the database or adds it if it does not yet exist.
 

Method Detail

addSocialEquitySetting

SocialEquitySetting addSocialEquitySetting(SocialEquitySetting socialEquitySetting)
                                           throws SystemException
Adds the social equity setting to the database. Also notifies the appropriate model listeners.

Parameters:
socialEquitySetting - the social equity setting
Returns:
the social equity setting that was added
Throws:
SystemException - if a system exception occurred

createSocialEquitySetting

SocialEquitySetting createSocialEquitySetting(long equitySettingId)
Creates a new social equity setting with the primary key. Does not add the social equity setting to the database.

Parameters:
equitySettingId - the primary key for the new social equity setting
Returns:
the new social equity setting

deleteSocialEquitySetting

void deleteSocialEquitySetting(long equitySettingId)
                               throws PortalException,
                                      SystemException
Deletes the social equity setting with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
equitySettingId - the primary key of the social equity setting
Throws:
PortalException - if a social equity setting with the primary key could not be found
SystemException - if a system exception occurred

deleteSocialEquitySetting

void deleteSocialEquitySetting(SocialEquitySetting socialEquitySetting)
                               throws SystemException
Deletes the social equity setting from the database. Also notifies the appropriate model listeners.

Parameters:
socialEquitySetting - the social equity setting
Throws:
SystemException - if a system exception occurred

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

getSocialEquitySetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquitySetting getSocialEquitySetting(long equitySettingId)
                                           throws PortalException,
                                                  SystemException
Returns the social equity setting with the primary key.

Parameters:
equitySettingId - the primary key of the social equity setting
Returns:
the social equity setting
Throws:
PortalException - if a social equity 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

getSocialEquitySettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquitySetting> getSocialEquitySettings(int start,
                                                                                           int end)
                                                  throws SystemException
Returns a range of all the social equity 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 equity settings
end - the upper bound of the range of social equity settings (not inclusive)
Returns:
the range of social equity settings
Throws:
SystemException - if a system exception occurred

getSocialEquitySettingsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSocialEquitySettingsCount()
                                 throws SystemException
Returns the number of social equity settings.

Returns:
the number of social equity settings
Throws:
SystemException - if a system exception occurred

updateSocialEquitySetting

SocialEquitySetting updateSocialEquitySetting(SocialEquitySetting socialEquitySetting)
                                              throws SystemException
Updates the social equity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
socialEquitySetting - the social equity setting
Returns:
the social equity setting that was updated
Throws:
SystemException - if a system exception occurred

updateSocialEquitySetting

SocialEquitySetting updateSocialEquitySetting(SocialEquitySetting socialEquitySetting,
                                              boolean merge)
                                              throws SystemException
Updates the social equity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
socialEquitySetting - the social equity setting
merge - whether to merge the social equity 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 equity 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

getEquitySettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquitySetting> getEquitySettings(long groupId,
                                                                                     String className,
                                                                                     String actionId)
                                            throws SystemException
Returns all the settings for the social equity action.

Parameters:
groupId - the primary key of the group
className - the class name for the target asset
actionId - the ID of the action
Returns:
the settings for the social equity action
Throws:
SystemException - if a system exception occurred

getEquitySettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquitySetting> getEquitySettings(long groupId,
                                                                                     long classNameId,
                                                                                     String actionId)
                                            throws SystemException
Returns all the settings for the social equity action.

Parameters:
groupId - the primary key of the group
classNameId - the ID of the target asset's class
actionId - the ID of the action
Returns:
the settings for the social equity action
Throws:
SystemException - if a system exception occurred

updateEquitySettings

void updateEquitySettings(long groupId,
                          String className,
                          List<SocialEquityActionMapping> equityActionMappings)
                          throws PortalException,
                                 SystemException
Updates settings for the model (asset type) in the group.

This method accepts a list of social equity action mappings. A SocialEquityActionMapping contains both participation and information settings for an action. The SocialEquityActionMapping class is used by the portal to store the default settings for social equity actions.

Parameters:
groupId - the primary key of the group
className - the class name of the target asset
equityActionMappings - the equity action mappings containing the settings to be stored
Throws:
PortalException - if the group could not be found
SystemException - if a system exception occurred

Liferay 6.1.0