com.liferay.portal.service.persistence
Interface LockPersistence

All Superinterfaces:

BasePersistence<Lock>

All Known Implementing Classes:

LockPersistenceImpl

public interface LockPersistence
extends BasePersistence<Lock>

The persistence interface for the lock service.

Never modify or reference this interface directly. Always use LockUtil to access the lock persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:

LockPersistenceImpl, LockUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

void	cacheResult(List<Lock> locks) Caches the locks in the entity cache if it is enabled.
void	cacheResult(Lock lock) Caches the lock in the entity cache if it is enabled.
int	countAll() Counts all the locks.
int	countByC_K(String className, String key) Counts all the locks where className = ? and key = ?.
int	countByLtExpirationDate(Date expirationDate) Counts all the locks where expirationDate < ?.
int	countByUuid(String uuid) Counts all the locks where uuid = ?.
Lock	create(long lockId) Creates a new lock with the primary key.
Lock	fetchByC_K(String className, String key) Finds the lock where className = ? and key = ? or returns null if it could not be found.
Lock	fetchByC_K(String className, String key, boolean retrieveFromCache) Finds the lock where className = ? and key = ? or returns null if it could not be found, optionally using the finder cache.
Lock	fetchByPrimaryKey(long lockId) Finds the lock with the primary key or returns null if it could not be found.
List<Lock>	findAll() Finds all the locks.
List<Lock>	findAll(int start, int end) Finds a range of all the locks.
List<Lock>	findAll(int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the locks.
Lock	findByC_K(String className, String key) Finds the lock where className = ? and key = ? or throws a NoSuchLockException if it could not be found.
Lock	findByLtExpirationDate_First(Date expirationDate, OrderByComparator orderByComparator) Finds the first lock in the ordered set where expirationDate < ?.
Lock	findByLtExpirationDate_Last(Date expirationDate, OrderByComparator orderByComparator) Finds the last lock in the ordered set where expirationDate < ?.
Lock[]	findByLtExpirationDate_PrevAndNext(long lockId, Date expirationDate, OrderByComparator orderByComparator) Finds the locks before and after the current lock in the ordered set where expirationDate < ?.
List<Lock>	findByLtExpirationDate(Date expirationDate) Finds all the locks where expirationDate < ?.
List<Lock>	findByLtExpirationDate(Date expirationDate, int start, int end) Finds a range of all the locks where expirationDate < ?.
List<Lock>	findByLtExpirationDate(Date expirationDate, int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the locks where expirationDate < ?.
Lock	findByPrimaryKey(long lockId) Finds the lock with the primary key or throws a NoSuchLockException if it could not be found.
Lock	findByUuid_First(String uuid, OrderByComparator orderByComparator) Finds the first lock in the ordered set where uuid = ?.
Lock	findByUuid_Last(String uuid, OrderByComparator orderByComparator) Finds the last lock in the ordered set where uuid = ?.
Lock[]	findByUuid_PrevAndNext(long lockId, String uuid, OrderByComparator orderByComparator) Finds the locks before and after the current lock in the ordered set where uuid = ?.
List<Lock>	findByUuid(String uuid) Finds all the locks where uuid = ?.
List<Lock>	findByUuid(String uuid, int start, int end) Finds a range of all the locks where uuid = ?.
List<Lock>	findByUuid(String uuid, int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the locks where uuid = ?.
Lock	remove(long lockId) Removes the lock with the primary key from the database.
void	removeAll() Removes all the locks from the database.
void	removeByC_K(String className, String key) Removes the lock where className = ? and key = ? from the database.
void	removeByLtExpirationDate(Date expirationDate) Removes all the locks where expirationDate < ? from the database.
void	removeByUuid(String uuid) Removes all the locks where uuid = ? from the database.
Lock	updateImpl(Lock lock, boolean merge)

Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence

clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update

Method Detail

cacheResult

void cacheResult(Lock lock)

Caches the lock in the entity cache if it is enabled.

Parameters:

lock - the lock to cache

cacheResult

void cacheResult(List<Lock> locks)

Caches the locks in the entity cache if it is enabled.

Parameters:

locks - the locks to cache

create

Lock create(long lockId)

Creates a new lock with the primary key. Does not add the lock to the database.

Parameters:

lockId - the primary key for the new lock

Returns:

the new lock

remove

Lock remove(long lockId)
            throws NoSuchLockException,
                   SystemException

Removes the lock with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

lockId - the primary key of the lock to remove

Returns:

the lock that was removed

Throws:

NoSuchLockException - if a lock with the primary key could not be found

SystemException - if a system exception occurred

updateImpl

Lock updateImpl(Lock lock,
                boolean merge)
                throws SystemException

Throws:

SystemException

findByPrimaryKey

Lock findByPrimaryKey(long lockId)
                      throws NoSuchLockException,
                             SystemException

Finds the lock with the primary key or throws a NoSuchLockException if it could not be found.

Parameters:

lockId - the primary key of the lock to find

Returns:

the lock

Throws:

NoSuchLockException - if a lock with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

Lock fetchByPrimaryKey(long lockId)
                       throws SystemException

Finds the lock with the primary key or returns null if it could not be found.

Parameters:

lockId - the primary key of the lock to find

Returns:

the lock, or null if a lock with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findByUuid

List<Lock> findByUuid(String uuid)
                      throws SystemException

Finds all the locks where uuid = ?.

Parameters:

uuid - the uuid to search with

Returns:

the matching locks

Throws:

SystemException - if a system exception occurred

findByUuid

List<Lock> findByUuid(String uuid,
                      int start,
                      int end)
                      throws SystemException

Finds a range of all the locks 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 locks to return

end - the upper bound of the range of locks to return (not inclusive)

Returns:

the range of matching locks

Throws:

SystemException - if a system exception occurred

findByUuid

List<Lock> findByUuid(String uuid,
                      int start,
                      int end,
                      OrderByComparator orderByComparator)
                      throws SystemException

Finds an ordered range of all the locks 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 locks to return

end - the upper bound of the range of locks to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching locks

Throws:

SystemException - if a system exception occurred

findByUuid_First

Lock findByUuid_First(String uuid,
                      OrderByComparator orderByComparator)
                      throws NoSuchLockException,
                             SystemException

Finds the first lock 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 lock

Throws:

NoSuchLockException - if a matching lock could not be found

SystemException - if a system exception occurred

findByUuid_Last

Lock findByUuid_Last(String uuid,
                     OrderByComparator orderByComparator)
                     throws NoSuchLockException,
                            SystemException

Finds the last lock 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 lock

Throws:

NoSuchLockException - if a matching lock could not be found

SystemException - if a system exception occurred

findByUuid_PrevAndNext

Lock[] findByUuid_PrevAndNext(long lockId,
                              String uuid,
                              OrderByComparator orderByComparator)
                              throws NoSuchLockException,
                                     SystemException

Finds the locks before and after the current lock 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:

lockId - the primary key of the current lock

uuid - the uuid to search with

orderByComparator - the comparator to order the set by

Returns:

the previous, current, and next lock

Throws:

NoSuchLockException - if a lock with the primary key could not be found

SystemException - if a system exception occurred

findByLtExpirationDate

List<Lock> findByLtExpirationDate(Date expirationDate)
                                  throws SystemException

Finds all the locks where expirationDate < ?.

Parameters:

expirationDate - the expiration date to search with

Returns:

the matching locks

Throws:

SystemException - if a system exception occurred

findByLtExpirationDate

List<Lock> findByLtExpirationDate(Date expirationDate,
                                  int start,
                                  int end)
                                  throws SystemException

Finds a range of all the locks where expirationDate < ?.

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:

expirationDate - the expiration date to search with

start - the lower bound of the range of locks to return

end - the upper bound of the range of locks to return (not inclusive)

Returns:

the range of matching locks

Throws:

SystemException - if a system exception occurred

findByLtExpirationDate

List<Lock> findByLtExpirationDate(Date expirationDate,
                                  int start,
                                  int end,
                                  OrderByComparator orderByComparator)
                                  throws SystemException

Finds an ordered range of all the locks where expirationDate < ?.

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:

expirationDate - the expiration date to search with

start - the lower bound of the range of locks to return

end - the upper bound of the range of locks to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching locks

Throws:

SystemException - if a system exception occurred

findByLtExpirationDate_First

Lock findByLtExpirationDate_First(Date expirationDate,
                                  OrderByComparator orderByComparator)
                                  throws NoSuchLockException,
                                         SystemException

Finds the first lock in the ordered set where expirationDate < ?.

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:

expirationDate - the expiration date to search with

orderByComparator - the comparator to order the set by

Returns:

the first matching lock

Throws:

NoSuchLockException - if a matching lock could not be found

SystemException - if a system exception occurred

findByLtExpirationDate_Last

Lock findByLtExpirationDate_Last(Date expirationDate,
                                 OrderByComparator orderByComparator)
                                 throws NoSuchLockException,
                                        SystemException

Finds the last lock in the ordered set where expirationDate < ?.

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:

expirationDate - the expiration date to search with

orderByComparator - the comparator to order the set by

Returns:

the last matching lock

Throws:

NoSuchLockException - if a matching lock could not be found

SystemException - if a system exception occurred

findByLtExpirationDate_PrevAndNext

Lock[] findByLtExpirationDate_PrevAndNext(long lockId,
                                          Date expirationDate,
                                          OrderByComparator orderByComparator)
                                          throws NoSuchLockException,
                                                 SystemException

Finds the locks before and after the current lock in the ordered set where expirationDate < ?.

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:

lockId - the primary key of the current lock

expirationDate - the expiration date to search with

orderByComparator - the comparator to order the set by

Returns:

the previous, current, and next lock

Throws:

NoSuchLockException - if a lock with the primary key could not be found

SystemException - if a system exception occurred

findByC_K

Lock findByC_K(String className,
               String key)
               throws NoSuchLockException,
                      SystemException

Finds the lock where className = ? and key = ? or throws a NoSuchLockException if it could not be found.

Parameters:

className - the class name to search with

key - the key to search with

Returns:

the matching lock

Throws:

NoSuchLockException - if a matching lock could not be found

SystemException - if a system exception occurred

fetchByC_K

Lock fetchByC_K(String className,
                String key)
                throws SystemException

Finds the lock where className = ? and key = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

className - the class name to search with

key - the key to search with

Returns:

the matching lock, or null if a matching lock could not be found

Throws:

SystemException - if a system exception occurred

fetchByC_K

Lock fetchByC_K(String className,
                String key,
                boolean retrieveFromCache)
                throws SystemException

Finds the lock where className = ? and key = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

className - the class name to search with

key - the key to search with

Returns:

the matching lock, or null if a matching lock could not be found

Throws:

SystemException - if a system exception occurred

findAll

List<Lock> findAll()
                   throws SystemException

Finds all the locks.

Returns:

the locks

Throws:

SystemException - if a system exception occurred

findAll

List<Lock> findAll(int start,
                   int end)
                   throws SystemException

Finds a range of all the locks.

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 locks to return

end - the upper bound of the range of locks to return (not inclusive)

Returns:

the range of locks

Throws:

SystemException - if a system exception occurred

findAll

List<Lock> findAll(int start,
                   int end,
                   OrderByComparator orderByComparator)
                   throws SystemException

Finds an ordered range of all the locks.

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 locks to return

end - the upper bound of the range of locks to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of locks

Throws:

SystemException - if a system exception occurred

removeByUuid

void removeByUuid(String uuid)
                  throws SystemException

Removes all the locks where uuid = ? from the database.

Parameters:

uuid - the uuid to search with

Throws:

SystemException - if a system exception occurred

removeByLtExpirationDate

void removeByLtExpirationDate(Date expirationDate)
                              throws SystemException

Removes all the locks where expirationDate < ? from the database.

Parameters:

expirationDate - the expiration date to search with

Throws:

SystemException - if a system exception occurred

removeByC_K

void removeByC_K(String className,
                 String key)
                 throws NoSuchLockException,
                        SystemException

Removes the lock where className = ? and key = ? from the database.

Parameters:

className - the class name to search with

key - the key to search with

Throws:

SystemException - if a system exception occurred

NoSuchLockException

removeAll

void removeAll()
               throws SystemException

Removes all the locks from the database.

Throws:

SystemException - if a system exception occurred

countByUuid

int countByUuid(String uuid)
                throws SystemException

Counts all the locks where uuid = ?.

Parameters:

uuid - the uuid to search with

Returns:

the number of matching locks

Throws:

SystemException - if a system exception occurred

countByLtExpirationDate

int countByLtExpirationDate(Date expirationDate)
                            throws SystemException

Counts all the locks where expirationDate < ?.

Parameters:

expirationDate - the expiration date to search with

Returns:

the number of matching locks

Throws:

SystemException - if a system exception occurred

countByC_K

int countByC_K(String className,
               String key)
               throws SystemException

Counts all the locks where className = ? and key = ?.

Parameters:

className - the class name to search with

key - the key to search with

Returns:

the number of matching locks

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Counts all the locks.

Returns:

the number of locks

Throws:

SystemException - if a system exception occurred