Liferay 6.2-ce-ga5

com.liferay.portlet.announcements.service.persistence
Interface AnnouncementsFlagPersistence

All Superinterfaces:
BasePersistence<AnnouncementsFlag>

@ProviderType
public interface AnnouncementsFlagPersistence
extends BasePersistence<AnnouncementsFlag>

The persistence interface for the announcements flag service.

Caching information and settings can be found in portal.properties

See Also:
AnnouncementsFlagPersistenceImpl, AnnouncementsFlagUtil

Method Summary
 void cacheResult(AnnouncementsFlag announcementsFlag)
          Caches the announcements flag in the entity cache if it is enabled.
 void cacheResult(List<AnnouncementsFlag> announcementsFlags)
          Caches the announcements flags in the entity cache if it is enabled.
 int countAll()
          Returns the number of announcements flags.
 int countByEntryId(long entryId)
          Returns the number of announcements flags where entryId = ?.
 int countByU_E_V(long userId, long entryId, int value)
          Returns the number of announcements flags where userId = ? and entryId = ? and value = ?.
 AnnouncementsFlag create(long flagId)
          Creates a new announcements flag with the primary key.
 AnnouncementsFlag fetchByEntryId_First(long entryId, OrderByComparator orderByComparator)
          Returns the first announcements flag in the ordered set where entryId = ?.
 AnnouncementsFlag fetchByEntryId_Last(long entryId, OrderByComparator orderByComparator)
          Returns the last announcements flag in the ordered set where entryId = ?.
 AnnouncementsFlag fetchByPrimaryKey(long flagId)
          Returns the announcements flag with the primary key or returns null if it could not be found.
 AnnouncementsFlag fetchByU_E_V(long userId, long entryId, int value)
          Returns the announcements flag where userId = ? and entryId = ? and value = ? or returns null if it could not be found.
 AnnouncementsFlag fetchByU_E_V(long userId, long entryId, int value, boolean retrieveFromCache)
          Returns the announcements flag where userId = ? and entryId = ? and value = ? or returns null if it could not be found, optionally using the finder cache.
 List<AnnouncementsFlag> findAll()
          Returns all the announcements flags.
 List<AnnouncementsFlag> findAll(int start, int end)
          Returns a range of all the announcements flags.
 List<AnnouncementsFlag> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the announcements flags.
 AnnouncementsFlag findByEntryId_First(long entryId, OrderByComparator orderByComparator)
          Returns the first announcements flag in the ordered set where entryId = ?.
 AnnouncementsFlag findByEntryId_Last(long entryId, OrderByComparator orderByComparator)
          Returns the last announcements flag in the ordered set where entryId = ?.
 AnnouncementsFlag[] findByEntryId_PrevAndNext(long flagId, long entryId, OrderByComparator orderByComparator)
          Returns the announcements flags before and after the current announcements flag in the ordered set where entryId = ?.
 List<AnnouncementsFlag> findByEntryId(long entryId)
          Returns all the announcements flags where entryId = ?.
 List<AnnouncementsFlag> findByEntryId(long entryId, int start, int end)
          Returns a range of all the announcements flags where entryId = ?.
 List<AnnouncementsFlag> findByEntryId(long entryId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the announcements flags where entryId = ?.
 AnnouncementsFlag findByPrimaryKey(long flagId)
          Returns the announcements flag with the primary key or throws a NoSuchFlagException if it could not be found.
 AnnouncementsFlag findByU_E_V(long userId, long entryId, int value)
          Returns the announcements flag where userId = ? and entryId = ? and value = ? or throws a NoSuchFlagException if it could not be found.
 AnnouncementsFlag remove(long flagId)
          Removes the announcements flag with the primary key from the database.
 void removeAll()
          Removes all the announcements flags from the database.
 void removeByEntryId(long entryId)
          Removes all the announcements flags where entryId = ? from the database.
 AnnouncementsFlag removeByU_E_V(long userId, long entryId, int value)
          Removes the announcements flag where userId = ? and entryId = ? and value = ? from the database.
 AnnouncementsFlag updateImpl(AnnouncementsFlag announcementsFlag)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update, update, update
 

Method Detail

findByEntryId

List<AnnouncementsFlag> findByEntryId(long entryId)
                                      throws SystemException
Returns all the announcements flags where entryId = ?.

Parameters:
entryId - the entry ID
Returns:
the matching announcements flags
Throws:
SystemException - if a system exception occurred

findByEntryId

List<AnnouncementsFlag> findByEntryId(long entryId,
                                      int start,
                                      int end)
                                      throws SystemException
Returns a range of all the announcements flags where entryId = ?.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AnnouncementsFlagModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
entryId - the entry ID
start - the lower bound of the range of announcements flags
end - the upper bound of the range of announcements flags (not inclusive)
Returns:
the range of matching announcements flags
Throws:
SystemException - if a system exception occurred

findByEntryId

List<AnnouncementsFlag> findByEntryId(long entryId,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                                      throws SystemException
Returns an ordered range of all the announcements flags where entryId = ?.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AnnouncementsFlagModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
entryId - the entry ID
start - the lower bound of the range of announcements flags
end - the upper bound of the range of announcements flags (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching announcements flags
Throws:
SystemException - if a system exception occurred

findByEntryId_First

AnnouncementsFlag findByEntryId_First(long entryId,
                                      OrderByComparator orderByComparator)
                                      throws SystemException,
                                             NoSuchFlagException
Returns the first announcements flag in the ordered set where entryId = ?.

Parameters:
entryId - the entry ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching announcements flag
Throws:
NoSuchFlagException - if a matching announcements flag could not be found
SystemException - if a system exception occurred

fetchByEntryId_First

AnnouncementsFlag fetchByEntryId_First(long entryId,
                                       OrderByComparator orderByComparator)
                                       throws SystemException
Returns the first announcements flag in the ordered set where entryId = ?.

Parameters:
entryId - the entry ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching announcements flag, or null if a matching announcements flag could not be found
Throws:
SystemException - if a system exception occurred

findByEntryId_Last

AnnouncementsFlag findByEntryId_Last(long entryId,
                                     OrderByComparator orderByComparator)
                                     throws SystemException,
                                            NoSuchFlagException
Returns the last announcements flag in the ordered set where entryId = ?.

Parameters:
entryId - the entry ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching announcements flag
Throws:
NoSuchFlagException - if a matching announcements flag could not be found
SystemException - if a system exception occurred

fetchByEntryId_Last

AnnouncementsFlag fetchByEntryId_Last(long entryId,
                                      OrderByComparator orderByComparator)
                                      throws SystemException
Returns the last announcements flag in the ordered set where entryId = ?.

Parameters:
entryId - the entry ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching announcements flag, or null if a matching announcements flag could not be found
Throws:
SystemException - if a system exception occurred

findByEntryId_PrevAndNext

AnnouncementsFlag[] findByEntryId_PrevAndNext(long flagId,
                                              long entryId,
                                              OrderByComparator orderByComparator)
                                              throws SystemException,
                                                     NoSuchFlagException
Returns the announcements flags before and after the current announcements flag in the ordered set where entryId = ?.

Parameters:
flagId - the primary key of the current announcements flag
entryId - the entry ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next announcements flag
Throws:
NoSuchFlagException - if a announcements flag with the primary key could not be found
SystemException - if a system exception occurred

removeByEntryId

void removeByEntryId(long entryId)
                     throws SystemException
Removes all the announcements flags where entryId = ? from the database.

Parameters:
entryId - the entry ID
Throws:
SystemException - if a system exception occurred

countByEntryId

int countByEntryId(long entryId)
                   throws SystemException
Returns the number of announcements flags where entryId = ?.

Parameters:
entryId - the entry ID
Returns:
the number of matching announcements flags
Throws:
SystemException - if a system exception occurred

findByU_E_V

AnnouncementsFlag findByU_E_V(long userId,
                              long entryId,
                              int value)
                              throws SystemException,
                                     NoSuchFlagException
Returns the announcements flag where userId = ? and entryId = ? and value = ? or throws a NoSuchFlagException if it could not be found.

Parameters:
userId - the user ID
entryId - the entry ID
value - the value
Returns:
the matching announcements flag
Throws:
NoSuchFlagException - if a matching announcements flag could not be found
SystemException - if a system exception occurred

fetchByU_E_V

AnnouncementsFlag fetchByU_E_V(long userId,
                               long entryId,
                               int value)
                               throws SystemException
Returns the announcements flag where userId = ? and entryId = ? and value = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
userId - the user ID
entryId - the entry ID
value - the value
Returns:
the matching announcements flag, or null if a matching announcements flag could not be found
Throws:
SystemException - if a system exception occurred

fetchByU_E_V

AnnouncementsFlag fetchByU_E_V(long userId,
                               long entryId,
                               int value,
                               boolean retrieveFromCache)
                               throws SystemException
Returns the announcements flag where userId = ? and entryId = ? and value = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
userId - the user ID
entryId - the entry ID
value - the value
retrieveFromCache - whether to use the finder cache
Returns:
the matching announcements flag, or null if a matching announcements flag could not be found
Throws:
SystemException - if a system exception occurred

removeByU_E_V

AnnouncementsFlag removeByU_E_V(long userId,
                                long entryId,
                                int value)
                                throws SystemException,
                                       NoSuchFlagException
Removes the announcements flag where userId = ? and entryId = ? and value = ? from the database.

Parameters:
userId - the user ID
entryId - the entry ID
value - the value
Returns:
the announcements flag that was removed
Throws:
SystemException - if a system exception occurred
NoSuchFlagException

countByU_E_V

int countByU_E_V(long userId,
                 long entryId,
                 int value)
                 throws SystemException
Returns the number of announcements flags where userId = ? and entryId = ? and value = ?.

Parameters:
userId - the user ID
entryId - the entry ID
value - the value
Returns:
the number of matching announcements flags
Throws:
SystemException - if a system exception occurred

cacheResult

void cacheResult(AnnouncementsFlag announcementsFlag)
Caches the announcements flag in the entity cache if it is enabled.

Parameters:
announcementsFlag - the announcements flag

cacheResult

void cacheResult(List<AnnouncementsFlag> announcementsFlags)
Caches the announcements flags in the entity cache if it is enabled.

Parameters:
announcementsFlags - the announcements flags

create

AnnouncementsFlag create(long flagId)
Creates a new announcements flag with the primary key. Does not add the announcements flag to the database.

Parameters:
flagId - the primary key for the new announcements flag
Returns:
the new announcements flag

remove

AnnouncementsFlag remove(long flagId)
                         throws SystemException,
                                NoSuchFlagException
Removes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
flagId - the primary key of the announcements flag
Returns:
the announcements flag that was removed
Throws:
NoSuchFlagException - if a announcements flag with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

AnnouncementsFlag updateImpl(AnnouncementsFlag announcementsFlag)
                             throws SystemException
Throws:
SystemException

findByPrimaryKey

AnnouncementsFlag findByPrimaryKey(long flagId)
                                   throws SystemException,
                                          NoSuchFlagException
Returns the announcements flag with the primary key or throws a NoSuchFlagException if it could not be found.

Parameters:
flagId - the primary key of the announcements flag
Returns:
the announcements flag
Throws:
NoSuchFlagException - if a announcements flag with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

AnnouncementsFlag fetchByPrimaryKey(long flagId)
                                    throws SystemException
Returns the announcements flag with the primary key or returns null if it could not be found.

Parameters:
flagId - the primary key of the announcements flag
Returns:
the announcements flag, or null if a announcements flag with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<AnnouncementsFlag> findAll()
                                throws SystemException
Returns all the announcements flags.

Returns:
the announcements flags
Throws:
SystemException - if a system exception occurred

findAll

List<AnnouncementsFlag> findAll(int start,
                                int end)
                                throws SystemException
Returns a range of all the announcements flags.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AnnouncementsFlagModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of announcements flags
end - the upper bound of the range of announcements flags (not inclusive)
Returns:
the range of announcements flags
Throws:
SystemException - if a system exception occurred

findAll

List<AnnouncementsFlag> findAll(int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException
Returns an ordered range of all the announcements flags.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AnnouncementsFlagModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of announcements flags
end - the upper bound of the range of announcements flags (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of announcements flags
Throws:
SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException
Removes all the announcements flags from the database.

Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of announcements flags.

Returns:
the number of announcements flags
Throws:
SystemException - if a system exception occurred

Liferay 6.2-ce-ga5