Liferay 6.0.5

com.liferay.portlet.social.service
Interface SocialEquitySettingLocalService

All Known Implementing Classes:
SocialEquitySettingLocalServiceBaseImpl, SocialEquitySettingLocalServiceImpl, SocialEquitySettingLocalServiceWrapper

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

The interface for the social equity setting local service.

Never modify or reference this interface directly. Always use SocialEquitySettingLocalServiceUtil to access the social equity setting local service. Add custom service methods to SocialEquitySettingLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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, SocialEquitySettingLocalServiceBaseImpl, SocialEquitySettingLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

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)
          Counts the number of rows that match the dynamic query.
 List<SocialEquitySetting> getEquitySettings(long groupId, long classNameId, String actionId)
           
 List<SocialEquitySetting> getEquitySettings(long groupId, String className, String actionId)
           
 SocialEquitySetting getSocialEquitySetting(long equitySettingId)
          Gets the social equity setting with the primary key.
 List<SocialEquitySetting> getSocialEquitySettings(int start, int end)
          Gets a range of all the social equity settings.
 int getSocialEquitySettingsCount()
          Gets the number of social equity settings.
 SocialEquitySetting updateSocialEquitySetting(SocialEquitySetting socialEquitySetting)
          Updates the social equity setting in the database.
 SocialEquitySetting updateSocialEquitySetting(SocialEquitySetting socialEquitySetting, boolean merge)
          Updates the social equity setting in the database.
 void updateSocialEquitySettings(long groupId, String className, List<SocialEquityActionMapping> equityActionMappings)
           
 

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 to add
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 to delete
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 to delete
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 to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
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
Gets the social equity setting with the primary key.

Parameters:
equitySettingId - the primary key of the social equity setting to get
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

getSocialEquitySettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquitySetting> getSocialEquitySettings(int start,
                                                                                           int end)
                                                  throws SystemException
Gets 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 to return
end - the upper bound of the range of social equity settings to return (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
Gets 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. Also notifies the appropriate model listeners.

Parameters:
socialEquitySetting - the social equity setting to update
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. Also notifies the appropriate model listeners.

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

getEquitySettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquitySetting> getEquitySettings(long groupId,
                                                                                     String className,
                                                                                     String actionId)
                                            throws SystemException
Throws:
SystemException

getEquitySettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquitySetting> getEquitySettings(long groupId,
                                                                                     long classNameId,
                                                                                     String actionId)
                                            throws SystemException
Throws:
SystemException

updateSocialEquitySettings

void updateSocialEquitySettings(long groupId,
                                String className,
                                List<SocialEquityActionMapping> equityActionMappings)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5