Liferay 6.1.2-ce-ga3

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.

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 it 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()
          Returns the number of locks.
 int countByC_K_O(String className, String key, String owner)
          Returns the number of locks where className = ? and key = ? and owner = ?.
 int countByC_K(String className, String key)
          Returns the number of locks where className = ? and key = ?.
 int countByLtExpirationDate(Date expirationDate)
          Returns the number of locks where expirationDate < ?.
 int countByUuid(String uuid)
          Returns the number of locks where uuid = ?.
 Lock create(long lockId)
          Creates a new lock with the primary key.
 Lock fetchByC_K_O(String className, String key, String owner)
          Returns the lock where className = ? and key = ? and owner = ? or returns null if it could not be found.
 Lock fetchByC_K_O(String className, String key, String owner, boolean retrieveFromCache)
          Returns the lock where className = ? and key = ? and owner = ? or returns null if it could not be found, optionally using the finder cache.
 Lock fetchByC_K(String className, String key)
          Returns the lock where className = ? and key = ? or returns null if it could not be found.
 Lock fetchByC_K(String className, String key, boolean retrieveFromCache)
          Returns the lock where className = ? and key = ? or returns null if it could not be found, optionally using the finder cache.
 Lock fetchByLtExpirationDate_First(Date expirationDate, OrderByComparator orderByComparator)
          Returns the first lock in the ordered set where expirationDate < ?.
 Lock fetchByLtExpirationDate_Last(Date expirationDate, OrderByComparator orderByComparator)
          Returns the last lock in the ordered set where expirationDate < ?.
 Lock fetchByPrimaryKey(long lockId)
          Returns the lock with the primary key or returns null if it could not be found.
 Lock fetchByUuid_First(String uuid, OrderByComparator orderByComparator)
          Returns the first lock in the ordered set where uuid = ?.
 Lock fetchByUuid_Last(String uuid, OrderByComparator orderByComparator)
          Returns the last lock in the ordered set where uuid = ?.
 List<Lock> findAll()
          Returns all the locks.
 List<Lock> findAll(int start, int end)
          Returns a range of all the locks.
 List<Lock> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the locks.
 Lock findByC_K_O(String className, String key, String owner)
          Returns the lock where className = ? and key = ? and owner = ? or throws a NoSuchLockException if it could not be found.
 Lock findByC_K(String className, String key)
          Returns the lock where className = ? and key = ? or throws a NoSuchLockException if it could not be found.
 Lock findByLtExpirationDate_First(Date expirationDate, OrderByComparator orderByComparator)
          Returns the first lock in the ordered set where expirationDate < ?.
 Lock findByLtExpirationDate_Last(Date expirationDate, OrderByComparator orderByComparator)
          Returns the last lock in the ordered set where expirationDate < ?.
 Lock[] findByLtExpirationDate_PrevAndNext(long lockId, Date expirationDate, OrderByComparator orderByComparator)
          Returns the locks before and after the current lock in the ordered set where expirationDate < ?.
 List<Lock> findByLtExpirationDate(Date expirationDate)
          Returns all the locks where expirationDate < ?.
 List<Lock> findByLtExpirationDate(Date expirationDate, int start, int end)
          Returns a range of all the locks where expirationDate < ?.
 List<Lock> findByLtExpirationDate(Date expirationDate, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the locks where expirationDate < ?.
 Lock findByPrimaryKey(long lockId)
          Returns the lock with the primary key or throws a NoSuchLockException if it could not be found.
 Lock findByUuid_First(String uuid, OrderByComparator orderByComparator)
          Returns the first lock in the ordered set where uuid = ?.
 Lock findByUuid_Last(String uuid, OrderByComparator orderByComparator)
          Returns the last lock in the ordered set where uuid = ?.
 Lock[] findByUuid_PrevAndNext(long lockId, String uuid, OrderByComparator orderByComparator)
          Returns the locks before and after the current lock in the ordered set where uuid = ?.
 List<Lock> findByUuid(String uuid)
          Returns all the locks where uuid = ?.
 List<Lock> findByUuid(String uuid, int start, int end)
          Returns a range of all the locks where uuid = ?.
 List<Lock> findByUuid(String uuid, int start, int end, OrderByComparator orderByComparator)
          Returns 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.
 Lock removeByC_K_O(String className, String key, String owner)
          Removes the lock where className = ? and key = ? and owner = ? from the database.
 Lock 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, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, 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

cacheResult

void cacheResult(List<Lock> locks)
Caches the locks in the entity cache if it is enabled.

Parameters:
locks - the locks

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
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
Returns the lock with the primary key or throws a NoSuchLockException if it could not be found.

Parameters:
lockId - the primary key of the lock
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
Returns the lock with the primary key or returns null if it could not be found.

Parameters:
lockId - the primary key of the lock
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
Returns all the locks where uuid = ?.

Parameters:
uuid - the uuid
Returns:
the matching locks
Throws:
SystemException - if a system exception occurred

findByUuid

List<Lock> findByUuid(String uuid,
                      int start,
                      int end)
                      throws SystemException
Returns 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
start - the lower bound of the range of locks
end - the upper bound of the range of locks (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
Returns 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
start - the lower bound of the range of locks
end - the upper bound of the range of locks (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
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
Returns the first lock in the ordered set where uuid = ?.

Parameters:
uuid - the uuid
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching lock
Throws:
NoSuchLockException - if a matching lock could not be found
SystemException - if a system exception occurred

fetchByUuid_First

Lock fetchByUuid_First(String uuid,
                       OrderByComparator orderByComparator)
                       throws SystemException
Returns the first lock in the ordered set where uuid = ?.

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

findByUuid_Last

Lock findByUuid_Last(String uuid,
                     OrderByComparator orderByComparator)
                     throws NoSuchLockException,
                            SystemException
Returns the last lock in the ordered set where uuid = ?.

Parameters:
uuid - the uuid
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching lock
Throws:
NoSuchLockException - if a matching lock could not be found
SystemException - if a system exception occurred

fetchByUuid_Last

Lock fetchByUuid_Last(String uuid,
                      OrderByComparator orderByComparator)
                      throws SystemException
Returns the last lock in the ordered set where uuid = ?.

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

findByUuid_PrevAndNext

Lock[] findByUuid_PrevAndNext(long lockId,
                              String uuid,
                              OrderByComparator orderByComparator)
                              throws NoSuchLockException,
                                     SystemException
Returns the locks before and after the current lock in the ordered set where uuid = ?.

Parameters:
lockId - the primary key of the current lock
uuid - the uuid
orderByComparator - the comparator to order the set by (optionally null)
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
Returns all the locks where expirationDate < ?.

Parameters:
expirationDate - the expiration date
Returns:
the matching locks
Throws:
SystemException - if a system exception occurred

findByLtExpirationDate

List<Lock> findByLtExpirationDate(Date expirationDate,
                                  int start,
                                  int end)
                                  throws SystemException
Returns 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
start - the lower bound of the range of locks
end - the upper bound of the range of locks (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
Returns 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
start - the lower bound of the range of locks
end - the upper bound of the range of locks (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
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
Returns the first lock in the ordered set where expirationDate < ?.

Parameters:
expirationDate - the expiration date
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching lock
Throws:
NoSuchLockException - if a matching lock could not be found
SystemException - if a system exception occurred

fetchByLtExpirationDate_First

Lock fetchByLtExpirationDate_First(Date expirationDate,
                                   OrderByComparator orderByComparator)
                                   throws SystemException
Returns the first lock in the ordered set where expirationDate < ?.

Parameters:
expirationDate - the expiration date
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching lock, or null if a matching lock could not be found
Throws:
SystemException - if a system exception occurred

findByLtExpirationDate_Last

Lock findByLtExpirationDate_Last(Date expirationDate,
                                 OrderByComparator orderByComparator)
                                 throws NoSuchLockException,
                                        SystemException
Returns the last lock in the ordered set where expirationDate < ?.

Parameters:
expirationDate - the expiration date
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching lock
Throws:
NoSuchLockException - if a matching lock could not be found
SystemException - if a system exception occurred

fetchByLtExpirationDate_Last

Lock fetchByLtExpirationDate_Last(Date expirationDate,
                                  OrderByComparator orderByComparator)
                                  throws SystemException
Returns the last lock in the ordered set where expirationDate < ?.

Parameters:
expirationDate - the expiration date
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching lock, or null if a matching lock could not be found
Throws:
SystemException - if a system exception occurred

findByLtExpirationDate_PrevAndNext

Lock[] findByLtExpirationDate_PrevAndNext(long lockId,
                                          Date expirationDate,
                                          OrderByComparator orderByComparator)
                                          throws NoSuchLockException,
                                                 SystemException
Returns the locks before and after the current lock in the ordered set where expirationDate < ?.

Parameters:
lockId - the primary key of the current lock
expirationDate - the expiration date
orderByComparator - the comparator to order the set by (optionally null)
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
Returns the lock where className = ? and key = ? or throws a NoSuchLockException if it could not be found.

Parameters:
className - the class name
key - the key
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
Returns the lock where className = ? and key = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
className - the class name
key - the key
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
Returns 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
key - the key
retrieveFromCache - whether to use the finder cache
Returns:
the matching lock, or null if a matching lock could not be found
Throws:
SystemException - if a system exception occurred

findByC_K_O

Lock findByC_K_O(String className,
                 String key,
                 String owner)
                 throws NoSuchLockException,
                        SystemException
Returns the lock where className = ? and key = ? and owner = ? or throws a NoSuchLockException if it could not be found.

Parameters:
className - the class name
key - the key
owner - the owner
Returns:
the matching lock
Throws:
NoSuchLockException - if a matching lock could not be found
SystemException - if a system exception occurred

fetchByC_K_O

Lock fetchByC_K_O(String className,
                  String key,
                  String owner)
                  throws SystemException
Returns the lock where className = ? and key = ? and owner = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
className - the class name
key - the key
owner - the owner
Returns:
the matching lock, or null if a matching lock could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_K_O

Lock fetchByC_K_O(String className,
                  String key,
                  String owner,
                  boolean retrieveFromCache)
                  throws SystemException
Returns the lock where className = ? and key = ? and owner = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
className - the class name
key - the key
owner - the owner
retrieveFromCache - whether to use the finder cache
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
Returns all the locks.

Returns:
the locks
Throws:
SystemException - if a system exception occurred

findAll

List<Lock> findAll(int start,
                   int end)
                   throws SystemException
Returns 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
end - the upper bound of the range of locks (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
Returns 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
end - the upper bound of the range of locks (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
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
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
Throws:
SystemException - if a system exception occurred

removeByC_K

Lock removeByC_K(String className,
                 String key)
                 throws NoSuchLockException,
                        SystemException
Removes the lock where className = ? and key = ? from the database.

Parameters:
className - the class name
key - the key
Returns:
the lock that was removed
Throws:
SystemException - if a system exception occurred
NoSuchLockException

removeByC_K_O

Lock removeByC_K_O(String className,
                   String key,
                   String owner)
                   throws NoSuchLockException,
                          SystemException
Removes the lock where className = ? and key = ? and owner = ? from the database.

Parameters:
className - the class name
key - the key
owner - the owner
Returns:
the lock that was removed
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
Returns the number of locks where uuid = ?.

Parameters:
uuid - the uuid
Returns:
the number of matching locks
Throws:
SystemException - if a system exception occurred

countByLtExpirationDate

int countByLtExpirationDate(Date expirationDate)
                            throws SystemException
Returns the number of locks where expirationDate < ?.

Parameters:
expirationDate - the expiration date
Returns:
the number of matching locks
Throws:
SystemException - if a system exception occurred

countByC_K

int countByC_K(String className,
               String key)
               throws SystemException
Returns the number of locks where className = ? and key = ?.

Parameters:
className - the class name
key - the key
Returns:
the number of matching locks
Throws:
SystemException - if a system exception occurred

countByC_K_O

int countByC_K_O(String className,
                 String key,
                 String owner)
                 throws SystemException
Returns the number of locks where className = ? and key = ? and owner = ?.

Parameters:
className - the class name
key - the key
owner - the owner
Returns:
the number of matching locks
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of locks.

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

Liferay 6.1.2-ce-ga3