Liferay 6.1.0

com.liferay.portlet.social.service
Interface SocialEquityGroupSettingLocalService

All Superinterfaces:
PersistedModelLocalService
All Known Implementing Classes:
SocialEquityGroupSettingLocalServiceWrapper

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

The interface for the social equity group 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:
SocialEquityGroupSettingLocalServiceUtil, com.liferay.portlet.social.service.base.SocialEquityGroupSettingLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialEquityGroupSettingLocalServiceImpl

Method Summary
 SocialEquityGroupSetting addSocialEquityGroupSetting(SocialEquityGroupSetting socialEquityGroupSetting)
          Adds the social equity group setting to the database.
 SocialEquityGroupSetting createSocialEquityGroupSetting(long equityGroupSettingId)
          Creates a new social equity group setting with the primary key.
 void deleteSocialEquityGroupSetting(long equityGroupSettingId)
          Deletes the social equity group setting with the primary key from the database.
 void deleteSocialEquityGroupSetting(SocialEquityGroupSetting socialEquityGroupSetting)
          Deletes the social equity group 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.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 SocialEquityGroupSetting getSocialEquityGroupSetting(long equityGroupSettingId)
          Returns the social equity group setting with the primary key.
 List<SocialEquityGroupSetting> getSocialEquityGroupSettings(int start, int end)
          Returns a range of all the social equity group settings.
 int getSocialEquityGroupSettingsCount()
          Returns the number of social equity group settings.
 boolean isEnabled(long groupId, String className)
          Returns true if social equity is turned on for the model (asset type) in the group.
 boolean isEnabled(long groupId, String className, int type)
          Returns true if the specified social equity scoring type is turned on for the model (asset type) in the group.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void updateEquityGroupSetting(long groupId, String className, int type, boolean enabled)
          Updates the group related social equity settings for the group and model (asset type).
 SocialEquityGroupSetting updateSocialEquityGroupSetting(SocialEquityGroupSetting socialEquityGroupSetting)
          Updates the social equity group setting in the database or adds it if it does not yet exist.
 SocialEquityGroupSetting updateSocialEquityGroupSetting(SocialEquityGroupSetting socialEquityGroupSetting, boolean merge)
          Updates the social equity group setting in the database or adds it if it does not yet exist.
 

Method Detail

addSocialEquityGroupSetting

SocialEquityGroupSetting addSocialEquityGroupSetting(SocialEquityGroupSetting socialEquityGroupSetting)
                                                     throws SystemException
Adds the social equity group setting to the database. Also notifies the appropriate model listeners.

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

createSocialEquityGroupSetting

SocialEquityGroupSetting createSocialEquityGroupSetting(long equityGroupSettingId)
Creates a new social equity group setting with the primary key. Does not add the social equity group setting to the database.

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

deleteSocialEquityGroupSetting

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

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

deleteSocialEquityGroupSetting

void deleteSocialEquityGroupSetting(SocialEquityGroupSetting socialEquityGroupSetting)
                                    throws SystemException
Deletes the social equity group setting from the database. Also notifies the appropriate model listeners.

Parameters:
socialEquityGroupSetting - the social equity group 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

getSocialEquityGroupSetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityGroupSetting getSocialEquityGroupSetting(long equityGroupSettingId)
                                                     throws PortalException,
                                                            SystemException
Returns the social equity group setting with the primary key.

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

getSocialEquityGroupSettings

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

getSocialEquityGroupSettingsCount

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

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

updateSocialEquityGroupSetting

SocialEquityGroupSetting updateSocialEquityGroupSetting(SocialEquityGroupSetting socialEquityGroupSetting)
                                                        throws SystemException
Updates the social equity group setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

updateSocialEquityGroupSetting

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

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

isEnabled

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isEnabled(long groupId,
                                                           String className)
                  throws SystemException
Returns true if social equity is turned on for the model (asset type) in the group.

Parameters:
groupId - the primary key of the group
className - the class name for the target asset type
Returns:
true if social equity is enabled for the model; false otherwise
Throws:
SystemException - if a system exception occurred

isEnabled

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isEnabled(long groupId,
                                                           String className,
                                                           int type)
                  throws SystemException
Returns true if the specified social equity scoring type is turned on for the model (asset type) in the group.

Parameters:
groupId - the primary key of the group
className - the class name for the target asset type
type - the social equity score type, acceptable values are SocialEquitySettingConstants.TYPE_INFORMATION and SocialEquitySettingConstants.TYPE_PARTICIPATION
Returns:
true if the given type of social equity scoring is enabled for the model; false otherwise
Throws:
SystemException - if a system exception occurred

updateEquityGroupSetting

void updateEquityGroupSetting(long groupId,
                              String className,
                              int type,
                              boolean enabled)
                              throws PortalException,
                                     SystemException
Updates the group related social equity settings for the group and model (asset type).

This method stores whether the social equity scoring type (information or participation) is turned on for the model in the group.

Parameters:
groupId - the primary key of the group
className - the class name for the target asset
type - the social equity score type, acceptable values are SocialEquitySettingConstants.TYPE_INFORMATION, SocialEquitySettingConstants.TYPE_PARTICIPATION
enabled - whether social equity is turned on
Throws:
PortalException - if the group could not be found
SystemException - if a system exception occurred

Liferay 6.1.0