Liferay 6.1.0

com.liferay.portlet.social.service.persistence
Interface SocialEquityGroupSettingPersistence

All Superinterfaces:
BasePersistence<SocialEquityGroupSetting>

public interface SocialEquityGroupSettingPersistence
extends BasePersistence<SocialEquityGroupSetting>

The persistence interface for the social equity group setting service.

Caching information and settings can be found in portal.properties

See Also:
SocialEquityGroupSettingPersistenceImpl, SocialEquityGroupSettingUtil

Method Summary
 void cacheResult(List<SocialEquityGroupSetting> socialEquityGroupSettings)
          Caches the social equity group settings in the entity cache if it is enabled.
 void cacheResult(SocialEquityGroupSetting socialEquityGroupSetting)
          Caches the social equity group setting in the entity cache if it is enabled.
 int countAll()
          Returns the number of social equity group settings.
 int countByG_C_T(long groupId, long classNameId, int type)
          Returns the number of social equity group settings where groupId = ? and classNameId = ? and type = ?.
 SocialEquityGroupSetting create(long equityGroupSettingId)
          Creates a new social equity group setting with the primary key.
 SocialEquityGroupSetting fetchByG_C_T(long groupId, long classNameId, int type)
          Returns the social equity group setting where groupId = ? and classNameId = ? and type = ? or returns null if it could not be found.
 SocialEquityGroupSetting fetchByG_C_T(long groupId, long classNameId, int type, boolean retrieveFromCache)
          Returns the social equity group setting where groupId = ? and classNameId = ? and type = ? or returns null if it could not be found, optionally using the finder cache.
 SocialEquityGroupSetting fetchByPrimaryKey(long equityGroupSettingId)
          Returns the social equity group setting with the primary key or returns null if it could not be found.
 List<SocialEquityGroupSetting> findAll()
          Returns all the social equity group settings.
 List<SocialEquityGroupSetting> findAll(int start, int end)
          Returns a range of all the social equity group settings.
 List<SocialEquityGroupSetting> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the social equity group settings.
 SocialEquityGroupSetting findByG_C_T(long groupId, long classNameId, int type)
          Returns the social equity group setting where groupId = ? and classNameId = ? and type = ? or throws a NoSuchEquityGroupSettingException if it could not be found.
 SocialEquityGroupSetting findByPrimaryKey(long equityGroupSettingId)
          Returns the social equity group setting with the primary key or throws a NoSuchEquityGroupSettingException if it could not be found.
 SocialEquityGroupSetting remove(long equityGroupSettingId)
          Removes the social equity group setting with the primary key from the database.
 SocialEquityGroupSetting remove(SocialEquityGroupSetting socialEquityGroupSetting)
          Removes the model instance from the database.
 void removeAll()
          Removes all the social equity group settings from the database.
 void removeByG_C_T(long groupId, long classNameId, int type)
          Removes the social equity group setting where groupId = ? and classNameId = ? and type = ? from the database.
 SocialEquityGroupSetting updateImpl(SocialEquityGroupSetting socialEquityGroupSetting, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, registerListener, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(SocialEquityGroupSetting socialEquityGroupSetting)
Caches the social equity group setting in the entity cache if it is enabled.

Parameters:
socialEquityGroupSetting - the social equity group setting

cacheResult

void cacheResult(List<SocialEquityGroupSetting> socialEquityGroupSettings)
Caches the social equity group settings in the entity cache if it is enabled.

Parameters:
socialEquityGroupSettings - the social equity group settings

create

SocialEquityGroupSetting create(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

remove

SocialEquityGroupSetting remove(long equityGroupSettingId)
                                throws SystemException,
                                       NoSuchEquityGroupSettingException
Removes 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
Returns:
the social equity group setting that was removed
Throws:
NoSuchEquityGroupSettingException - if a social equity group setting with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

SocialEquityGroupSetting updateImpl(SocialEquityGroupSetting socialEquityGroupSetting,
                                    boolean merge)
                                    throws SystemException
Throws:
SystemException

findByPrimaryKey

SocialEquityGroupSetting findByPrimaryKey(long equityGroupSettingId)
                                          throws SystemException,
                                                 NoSuchEquityGroupSettingException
Returns the social equity group setting with the primary key or throws a NoSuchEquityGroupSettingException if it could not be found.

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

fetchByPrimaryKey

SocialEquityGroupSetting fetchByPrimaryKey(long equityGroupSettingId)
                                           throws SystemException
Returns the social equity group setting with the primary key or returns null if it could not be found.

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

findByG_C_T

SocialEquityGroupSetting findByG_C_T(long groupId,
                                     long classNameId,
                                     int type)
                                     throws SystemException,
                                            NoSuchEquityGroupSettingException
Returns the social equity group setting where groupId = ? and classNameId = ? and type = ? or throws a NoSuchEquityGroupSettingException if it could not be found.

Parameters:
groupId - the group ID
classNameId - the class name ID
type - the type
Returns:
the matching social equity group setting
Throws:
NoSuchEquityGroupSettingException - if a matching social equity group setting could not be found
SystemException - if a system exception occurred

fetchByG_C_T

SocialEquityGroupSetting fetchByG_C_T(long groupId,
                                      long classNameId,
                                      int type)
                                      throws SystemException
Returns the social equity group setting where groupId = ? and classNameId = ? and type = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
groupId - the group ID
classNameId - the class name ID
type - the type
Returns:
the matching social equity group setting, or null if a matching social equity group setting could not be found
Throws:
SystemException - if a system exception occurred

fetchByG_C_T

SocialEquityGroupSetting fetchByG_C_T(long groupId,
                                      long classNameId,
                                      int type,
                                      boolean retrieveFromCache)
                                      throws SystemException
Returns the social equity group setting where groupId = ? and classNameId = ? and type = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
groupId - the group ID
classNameId - the class name ID
type - the type
retrieveFromCache - whether to use the finder cache
Returns:
the matching social equity group setting, or null if a matching social equity group setting could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<SocialEquityGroupSetting> findAll()
                                       throws SystemException
Returns all the social equity group settings.

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

findAll

List<SocialEquityGroupSetting> findAll(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

findAll

List<SocialEquityGroupSetting> findAll(int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                       throws SystemException
Returns an ordered 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)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of social equity group settings
Throws:
SystemException - if a system exception occurred

removeByG_C_T

void removeByG_C_T(long groupId,
                   long classNameId,
                   int type)
                   throws SystemException,
                          NoSuchEquityGroupSettingException
Removes the social equity group setting where groupId = ? and classNameId = ? and type = ? from the database.

Parameters:
groupId - the group ID
classNameId - the class name ID
type - the type
Throws:
SystemException - if a system exception occurred
NoSuchEquityGroupSettingException

removeAll

void removeAll()
               throws SystemException
Removes all the social equity group settings from the database.

Throws:
SystemException - if a system exception occurred

countByG_C_T

int countByG_C_T(long groupId,
                 long classNameId,
                 int type)
                 throws SystemException
Returns the number of social equity group settings where groupId = ? and classNameId = ? and type = ?.

Parameters:
groupId - the group ID
classNameId - the class name ID
type - the type
Returns:
the number of matching social equity group settings
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             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

remove

SocialEquityGroupSetting remove(SocialEquityGroupSetting socialEquityGroupSetting)
                                throws SystemException
Description copied from interface: BasePersistence
Removes the model instance from the database. Also notifies the appropriate model listeners.

Specified by:
remove in interface BasePersistence<SocialEquityGroupSetting>
Parameters:
socialEquityGroupSetting - the model instance to remove
Returns:
the model instance that was removed
Throws:
SystemException - if a system exception occurred

Liferay 6.1.0