Liferay 6.0-ee-sp2

com.liferay.portal.service.persistence
Interface UserNotificationEventPersistence

All Superinterfaces:
BasePersistence<UserNotificationEvent>

public interface UserNotificationEventPersistence
extends BasePersistence<UserNotificationEvent>

The persistence interface for the user notification event service.

Caching information and settings can be found in portal.properties

See Also:
UserNotificationEventPersistenceImpl, UserNotificationEventUtil

Method Summary
 void cacheResult(List<UserNotificationEvent> userNotificationEvents)
          Caches the user notification events in the entity cache if it is enabled.
 void cacheResult(UserNotificationEvent userNotificationEvent)
          Caches the user notification event in the entity cache if it is enabled.
 int countAll()
          Counts all the user notification events.
 int countByUserId(long userId)
          Counts all the user notification events where userId = ?.
 int countByUuid(String uuid)
          Counts all the user notification events where uuid = ?.
 UserNotificationEvent create(long userNotificationEventId)
          Creates a new user notification event with the primary key.
 UserNotificationEvent fetchByPrimaryKey(long userNotificationEventId)
          Finds the user notification event with the primary key or returns null if it could not be found.
 List<UserNotificationEvent> findAll()
          Finds all the user notification events.
 List<UserNotificationEvent> findAll(int start, int end)
          Finds a range of all the user notification events.
 List<UserNotificationEvent> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user notification events.
 UserNotificationEvent findByPrimaryKey(long userNotificationEventId)
          Finds the user notification event with the primary key or throws a NoSuchUserNotificationEventException if it could not be found.
 UserNotificationEvent findByUserId_First(long userId, OrderByComparator orderByComparator)
          Finds the first user notification event in the ordered set where userId = ?.
 UserNotificationEvent findByUserId_Last(long userId, OrderByComparator orderByComparator)
          Finds the last user notification event in the ordered set where userId = ?.
 UserNotificationEvent[] findByUserId_PrevAndNext(long userNotificationEventId, long userId, OrderByComparator orderByComparator)
          Finds the user notification events before and after the current user notification event in the ordered set where userId = ?.
 List<UserNotificationEvent> findByUserId(long userId)
          Finds all the user notification events where userId = ?.
 List<UserNotificationEvent> findByUserId(long userId, int start, int end)
          Finds a range of all the user notification events where userId = ?.
 List<UserNotificationEvent> findByUserId(long userId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user notification events where userId = ?.
 UserNotificationEvent findByUuid_First(String uuid, OrderByComparator orderByComparator)
          Finds the first user notification event in the ordered set where uuid = ?.
 UserNotificationEvent findByUuid_Last(String uuid, OrderByComparator orderByComparator)
          Finds the last user notification event in the ordered set where uuid = ?.
 UserNotificationEvent[] findByUuid_PrevAndNext(long userNotificationEventId, String uuid, OrderByComparator orderByComparator)
          Finds the user notification events before and after the current user notification event in the ordered set where uuid = ?.
 List<UserNotificationEvent> findByUuid(String uuid)
          Finds all the user notification events where uuid = ?.
 List<UserNotificationEvent> findByUuid(String uuid, int start, int end)
          Finds a range of all the user notification events where uuid = ?.
 List<UserNotificationEvent> findByUuid(String uuid, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user notification events where uuid = ?.
 UserNotificationEvent remove(long userNotificationEventId)
          Removes the user notification event with the primary key from the database.
 UserNotificationEvent remove(UserNotificationEvent userNotificationEvent)
          Removes the model instance from the database.
 void removeAll()
          Removes all the user notification events from the database.
 void removeByUserId(long userId)
          Removes all the user notification events where userId = ? from the database.
 void removeByUuid(String uuid)
          Removes all the user notification events where uuid = ? from the database.
 UserNotificationEvent updateImpl(UserNotificationEvent userNotificationEvent, 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(UserNotificationEvent userNotificationEvent)
Caches the user notification event in the entity cache if it is enabled.

Parameters:
userNotificationEvent - the user notification event to cache

cacheResult

void cacheResult(List<UserNotificationEvent> userNotificationEvents)
Caches the user notification events in the entity cache if it is enabled.

Parameters:
userNotificationEvents - the user notification events to cache

create

UserNotificationEvent create(long userNotificationEventId)
Creates a new user notification event with the primary key. Does not add the user notification event to the database.

Parameters:
userNotificationEventId - the primary key for the new user notification event
Returns:
the new user notification event

remove

UserNotificationEvent remove(long userNotificationEventId)
                             throws NoSuchUserNotificationEventException,
                                    SystemException
Removes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
userNotificationEventId - the primary key of the user notification event to remove
Returns:
the user notification event that was removed
Throws:
NoSuchUserNotificationEventException - if a user notification event with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

UserNotificationEvent updateImpl(UserNotificationEvent userNotificationEvent,
                                 boolean merge)
                                 throws SystemException
Throws:
SystemException

findByPrimaryKey

UserNotificationEvent findByPrimaryKey(long userNotificationEventId)
                                       throws NoSuchUserNotificationEventException,
                                              SystemException
Finds the user notification event with the primary key or throws a NoSuchUserNotificationEventException if it could not be found.

Parameters:
userNotificationEventId - the primary key of the user notification event to find
Returns:
the user notification event
Throws:
NoSuchUserNotificationEventException - if a user notification event with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

UserNotificationEvent fetchByPrimaryKey(long userNotificationEventId)
                                        throws SystemException
Finds the user notification event with the primary key or returns null if it could not be found.

Parameters:
userNotificationEventId - the primary key of the user notification event to find
Returns:
the user notification event, or null if a user notification event with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByUuid

List<UserNotificationEvent> findByUuid(String uuid)
                                       throws SystemException
Finds all the user notification events where uuid = ?.

Parameters:
uuid - the uuid to search with
Returns:
the matching user notification events
Throws:
SystemException - if a system exception occurred

findByUuid

List<UserNotificationEvent> findByUuid(String uuid,
                                       int start,
                                       int end)
                                       throws SystemException
Finds a range of all the user notification events where uuid = ?.

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:
uuid - the uuid to search with
start - the lower bound of the range of user notification events to return
end - the upper bound of the range of user notification events to return (not inclusive)
Returns:
the range of matching user notification events
Throws:
SystemException - if a system exception occurred

findByUuid

List<UserNotificationEvent> findByUuid(String uuid,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                       throws SystemException
Finds an ordered range of all the user notification events where uuid = ?.

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

findByUuid_First

UserNotificationEvent findByUuid_First(String uuid,
                                       OrderByComparator orderByComparator)
                                       throws NoSuchUserNotificationEventException,
                                              SystemException
Finds the first user notification event in the ordered set where uuid = ?.

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:
uuid - the uuid to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user notification event
Throws:
NoSuchUserNotificationEventException - if a matching user notification event could not be found
SystemException - if a system exception occurred

findByUuid_Last

UserNotificationEvent findByUuid_Last(String uuid,
                                      OrderByComparator orderByComparator)
                                      throws NoSuchUserNotificationEventException,
                                             SystemException
Finds the last user notification event in the ordered set where uuid = ?.

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:
uuid - the uuid to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user notification event
Throws:
NoSuchUserNotificationEventException - if a matching user notification event could not be found
SystemException - if a system exception occurred

findByUuid_PrevAndNext

UserNotificationEvent[] findByUuid_PrevAndNext(long userNotificationEventId,
                                               String uuid,
                                               OrderByComparator orderByComparator)
                                               throws NoSuchUserNotificationEventException,
                                                      SystemException
Finds the user notification events before and after the current user notification event in the ordered set where uuid = ?.

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:
userNotificationEventId - the primary key of the current user notification event
uuid - the uuid to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user notification event
Throws:
NoSuchUserNotificationEventException - if a user notification event with the primary key could not be found
SystemException - if a system exception occurred

findByUserId

List<UserNotificationEvent> findByUserId(long userId)
                                         throws SystemException
Finds all the user notification events where userId = ?.

Parameters:
userId - the user ID to search with
Returns:
the matching user notification events
Throws:
SystemException - if a system exception occurred

findByUserId

List<UserNotificationEvent> findByUserId(long userId,
                                         int start,
                                         int end)
                                         throws SystemException
Finds a range of all the user notification events where userId = ?.

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:
userId - the user ID to search with
start - the lower bound of the range of user notification events to return
end - the upper bound of the range of user notification events to return (not inclusive)
Returns:
the range of matching user notification events
Throws:
SystemException - if a system exception occurred

findByUserId

List<UserNotificationEvent> findByUserId(long userId,
                                         int start,
                                         int end,
                                         OrderByComparator orderByComparator)
                                         throws SystemException
Finds an ordered range of all the user notification events where userId = ?.

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

findByUserId_First

UserNotificationEvent findByUserId_First(long userId,
                                         OrderByComparator orderByComparator)
                                         throws NoSuchUserNotificationEventException,
                                                SystemException
Finds the first user notification event in the ordered set where userId = ?.

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:
userId - the user ID to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user notification event
Throws:
NoSuchUserNotificationEventException - if a matching user notification event could not be found
SystemException - if a system exception occurred

findByUserId_Last

UserNotificationEvent findByUserId_Last(long userId,
                                        OrderByComparator orderByComparator)
                                        throws NoSuchUserNotificationEventException,
                                               SystemException
Finds the last user notification event in the ordered set where userId = ?.

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:
userId - the user ID to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user notification event
Throws:
NoSuchUserNotificationEventException - if a matching user notification event could not be found
SystemException - if a system exception occurred

findByUserId_PrevAndNext

UserNotificationEvent[] findByUserId_PrevAndNext(long userNotificationEventId,
                                                 long userId,
                                                 OrderByComparator orderByComparator)
                                                 throws NoSuchUserNotificationEventException,
                                                        SystemException
Finds the user notification events before and after the current user notification event in the ordered set where userId = ?.

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:
userNotificationEventId - the primary key of the current user notification event
userId - the user ID to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user notification event
Throws:
NoSuchUserNotificationEventException - if a user notification event with the primary key could not be found
SystemException - if a system exception occurred

findAll

List<UserNotificationEvent> findAll()
                                    throws SystemException
Finds all the user notification events.

Returns:
the user notification events
Throws:
SystemException - if a system exception occurred

findAll

List<UserNotificationEvent> findAll(int start,
                                    int end)
                                    throws SystemException
Finds a range of all the user notification events.

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 user notification events to return
end - the upper bound of the range of user notification events to return (not inclusive)
Returns:
the range of user notification events
Throws:
SystemException - if a system exception occurred

findAll

List<UserNotificationEvent> findAll(int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                                    throws SystemException
Finds an ordered range of all the user notification events.

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 user notification events to return
end - the upper bound of the range of user notification events to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of user notification events
Throws:
SystemException - if a system exception occurred

removeByUuid

void removeByUuid(String uuid)
                  throws SystemException
Removes all the user notification events where uuid = ? from the database.

Parameters:
uuid - the uuid to search with
Throws:
SystemException - if a system exception occurred

removeByUserId

void removeByUserId(long userId)
                    throws SystemException
Removes all the user notification events where userId = ? from the database.

Parameters:
userId - the user ID to search with
Throws:
SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException
Removes all the user notification events from the database.

Throws:
SystemException - if a system exception occurred

countByUuid

int countByUuid(String uuid)
                throws SystemException
Counts all the user notification events where uuid = ?.

Parameters:
uuid - the uuid to search with
Returns:
the number of matching user notification events
Throws:
SystemException - if a system exception occurred

countByUserId

int countByUserId(long userId)
                  throws SystemException
Counts all the user notification events where userId = ?.

Parameters:
userId - the user ID to search with
Returns:
the number of matching user notification events
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the user notification events.

Returns:
the number of user notification events
Throws:
SystemException - if a system exception occurred

remove

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

Liferay 6.0-ee-sp2