Liferay 6.1.0

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

All Superinterfaces:
BasePersistence<SocialEquitySetting>

public interface SocialEquitySettingPersistence
extends BasePersistence<SocialEquitySetting>

The persistence interface for the social equity setting service.

Caching information and settings can be found in portal.properties

See Also:
SocialEquitySettingPersistenceImpl, SocialEquitySettingUtil

Method Summary
 void cacheResult(List<SocialEquitySetting> socialEquitySettings)
          Caches the social equity settings in the entity cache if it is enabled.
 void cacheResult(SocialEquitySetting socialEquitySetting)
          Caches the social equity setting in the entity cache if it is enabled.
 int countAll()
          Returns the number of social equity settings.
 int countByG_C_A_T(long groupId, long classNameId, String actionId, int type)
          Returns the number of social equity settings where groupId = ? and classNameId = ? and actionId = ? and type = ?.
 int countByG_C_A(long groupId, long classNameId, String actionId)
          Returns the number of social equity settings where groupId = ? and classNameId = ? and actionId = ?.
 SocialEquitySetting create(long equitySettingId)
          Creates a new social equity setting with the primary key.
 SocialEquitySetting fetchByG_C_A_T(long groupId, long classNameId, String actionId, int type)
          Returns the social equity setting where groupId = ? and classNameId = ? and actionId = ? and type = ? or returns null if it could not be found.
 SocialEquitySetting fetchByG_C_A_T(long groupId, long classNameId, String actionId, int type, boolean retrieveFromCache)
          Returns the social equity setting where groupId = ? and classNameId = ? and actionId = ? and type = ? or returns null if it could not be found, optionally using the finder cache.
 SocialEquitySetting fetchByPrimaryKey(long equitySettingId)
          Returns the social equity setting with the primary key or returns null if it could not be found.
 List<SocialEquitySetting> findAll()
          Returns all the social equity settings.
 List<SocialEquitySetting> findAll(int start, int end)
          Returns a range of all the social equity settings.
 List<SocialEquitySetting> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the social equity settings.
 SocialEquitySetting findByG_C_A_First(long groupId, long classNameId, String actionId, OrderByComparator orderByComparator)
          Returns the first social equity setting in the ordered set where groupId = ? and classNameId = ? and actionId = ?.
 SocialEquitySetting findByG_C_A_Last(long groupId, long classNameId, String actionId, OrderByComparator orderByComparator)
          Returns the last social equity setting in the ordered set where groupId = ? and classNameId = ? and actionId = ?.
 SocialEquitySetting[] findByG_C_A_PrevAndNext(long equitySettingId, long groupId, long classNameId, String actionId, OrderByComparator orderByComparator)
          Returns the social equity settings before and after the current social equity setting in the ordered set where groupId = ? and classNameId = ? and actionId = ?.
 SocialEquitySetting findByG_C_A_T(long groupId, long classNameId, String actionId, int type)
          Returns the social equity setting where groupId = ? and classNameId = ? and actionId = ? and type = ? or throws a NoSuchEquitySettingException if it could not be found.
 List<SocialEquitySetting> findByG_C_A(long groupId, long classNameId, String actionId)
          Returns all the social equity settings where groupId = ? and classNameId = ? and actionId = ?.
 List<SocialEquitySetting> findByG_C_A(long groupId, long classNameId, String actionId, int start, int end)
          Returns a range of all the social equity settings where groupId = ? and classNameId = ? and actionId = ?.
 List<SocialEquitySetting> findByG_C_A(long groupId, long classNameId, String actionId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the social equity settings where groupId = ? and classNameId = ? and actionId = ?.
 SocialEquitySetting findByPrimaryKey(long equitySettingId)
          Returns the social equity setting with the primary key or throws a NoSuchEquitySettingException if it could not be found.
 SocialEquitySetting remove(long equitySettingId)
          Removes the social equity setting with the primary key from the database.
 SocialEquitySetting remove(SocialEquitySetting socialEquitySetting)
          Removes the model instance from the database.
 void removeAll()
          Removes all the social equity settings from the database.
 void removeByG_C_A_T(long groupId, long classNameId, String actionId, int type)
          Removes the social equity setting where groupId = ? and classNameId = ? and actionId = ? and type = ? from the database.
 void removeByG_C_A(long groupId, long classNameId, String actionId)
          Removes all the social equity settings where groupId = ? and classNameId = ? and actionId = ? from the database.
 SocialEquitySetting updateImpl(SocialEquitySetting socialEquitySetting, 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(SocialEquitySetting socialEquitySetting)
Caches the social equity setting in the entity cache if it is enabled.

Parameters:
socialEquitySetting - the social equity setting

cacheResult

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

Parameters:
socialEquitySettings - the social equity settings

create

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

remove

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

updateImpl

SocialEquitySetting updateImpl(SocialEquitySetting socialEquitySetting,
                               boolean merge)
                               throws SystemException
Throws:
SystemException

findByPrimaryKey

SocialEquitySetting findByPrimaryKey(long equitySettingId)
                                     throws SystemException,
                                            NoSuchEquitySettingException
Returns the social equity setting with the primary key or throws a NoSuchEquitySettingException if it could not be found.

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

fetchByPrimaryKey

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

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

findByG_C_A

List<SocialEquitySetting> findByG_C_A(long groupId,
                                      long classNameId,
                                      String actionId)
                                      throws SystemException
Returns all the social equity settings where groupId = ? and classNameId = ? and actionId = ?.

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

findByG_C_A

List<SocialEquitySetting> findByG_C_A(long groupId,
                                      long classNameId,
                                      String actionId,
                                      int start,
                                      int end)
                                      throws SystemException
Returns a range of all the social equity settings where groupId = ? and classNameId = ? and actionId = ?.

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:
groupId - the group ID
classNameId - the class name ID
actionId - the action ID
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 matching social equity settings
Throws:
SystemException - if a system exception occurred

findByG_C_A

List<SocialEquitySetting> findByG_C_A(long groupId,
                                      long classNameId,
                                      String actionId,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                                      throws SystemException
Returns an ordered range of all the social equity settings where groupId = ? and classNameId = ? and actionId = ?.

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:
groupId - the group ID
classNameId - the class name ID
actionId - the action ID
start - the lower bound of the range of social equity settings
end - the upper bound of the range of social equity settings (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching social equity settings
Throws:
SystemException - if a system exception occurred

findByG_C_A_First

SocialEquitySetting findByG_C_A_First(long groupId,
                                      long classNameId,
                                      String actionId,
                                      OrderByComparator orderByComparator)
                                      throws SystemException,
                                             NoSuchEquitySettingException
Returns the first social equity setting in the ordered set where groupId = ? and classNameId = ? and actionId = ?.

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:
groupId - the group ID
classNameId - the class name ID
actionId - the action ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching social equity setting
Throws:
NoSuchEquitySettingException - if a matching social equity setting could not be found
SystemException - if a system exception occurred

findByG_C_A_Last

SocialEquitySetting findByG_C_A_Last(long groupId,
                                     long classNameId,
                                     String actionId,
                                     OrderByComparator orderByComparator)
                                     throws SystemException,
                                            NoSuchEquitySettingException
Returns the last social equity setting in the ordered set where groupId = ? and classNameId = ? and actionId = ?.

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:
groupId - the group ID
classNameId - the class name ID
actionId - the action ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching social equity setting
Throws:
NoSuchEquitySettingException - if a matching social equity setting could not be found
SystemException - if a system exception occurred

findByG_C_A_PrevAndNext

SocialEquitySetting[] findByG_C_A_PrevAndNext(long equitySettingId,
                                              long groupId,
                                              long classNameId,
                                              String actionId,
                                              OrderByComparator orderByComparator)
                                              throws SystemException,
                                                     NoSuchEquitySettingException
Returns the social equity settings before and after the current social equity setting in the ordered set where groupId = ? and classNameId = ? and actionId = ?.

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:
equitySettingId - the primary key of the current social equity setting
groupId - the group ID
classNameId - the class name ID
actionId - the action ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next social equity setting
Throws:
NoSuchEquitySettingException - if a social equity setting with the primary key could not be found
SystemException - if a system exception occurred

findByG_C_A_T

SocialEquitySetting findByG_C_A_T(long groupId,
                                  long classNameId,
                                  String actionId,
                                  int type)
                                  throws SystemException,
                                         NoSuchEquitySettingException
Returns the social equity setting where groupId = ? and classNameId = ? and actionId = ? and type = ? or throws a NoSuchEquitySettingException if it could not be found.

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

fetchByG_C_A_T

SocialEquitySetting fetchByG_C_A_T(long groupId,
                                   long classNameId,
                                   String actionId,
                                   int type)
                                   throws SystemException
Returns the social equity setting where groupId = ? and classNameId = ? and actionId = ? 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
actionId - the action ID
type - the type
Returns:
the matching social equity setting, or null if a matching social equity setting could not be found
Throws:
SystemException - if a system exception occurred

fetchByG_C_A_T

SocialEquitySetting fetchByG_C_A_T(long groupId,
                                   long classNameId,
                                   String actionId,
                                   int type,
                                   boolean retrieveFromCache)
                                   throws SystemException
Returns the social equity setting where groupId = ? and classNameId = ? and actionId = ? 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
actionId - the action ID
type - the type
retrieveFromCache - whether to use the finder cache
Returns:
the matching social equity setting, or null if a matching social equity setting could not be found
Throws:
SystemException - if a system exception occurred

findAll

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

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

findAll

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

findAll

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

removeByG_C_A

void removeByG_C_A(long groupId,
                   long classNameId,
                   String actionId)
                   throws SystemException
Removes all the social equity settings where groupId = ? and classNameId = ? and actionId = ? from the database.

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

removeByG_C_A_T

void removeByG_C_A_T(long groupId,
                     long classNameId,
                     String actionId,
                     int type)
                     throws SystemException,
                            NoSuchEquitySettingException
Removes the social equity setting where groupId = ? and classNameId = ? and actionId = ? and type = ? from the database.

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

removeAll

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

Throws:
SystemException - if a system exception occurred

countByG_C_A

int countByG_C_A(long groupId,
                 long classNameId,
                 String actionId)
                 throws SystemException
Returns the number of social equity settings where groupId = ? and classNameId = ? and actionId = ?.

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

countByG_C_A_T

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

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

countAll

int countAll()
             throws SystemException
Returns the number of social equity settings.

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

remove

SocialEquitySetting remove(SocialEquitySetting socialEquitySetting)
                           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<SocialEquitySetting>
Parameters:
socialEquitySetting - the model instance to remove
Returns:
the model instance that was removed
Throws:
SystemException - if a system exception occurred

Liferay 6.1.0