|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LockPersistence
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
LockPersistenceImpl
,
LockUtil
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 |
---|
void cacheResult(Lock lock)
lock
- the lock to cachevoid cacheResult(List<Lock> locks)
locks
- the locks to cacheLock create(long lockId)
lockId
- the primary key for the new lock
Lock remove(long lockId) throws NoSuchLockException, SystemException
lockId
- the primary key of the lock to remove
NoSuchLockException
- if a lock with the primary key could not be found
SystemException
- if a system exception occurredLock updateImpl(Lock lock, boolean merge) throws SystemException
SystemException
Lock findByPrimaryKey(long lockId) throws NoSuchLockException, SystemException
NoSuchLockException
if it could not be found.
lockId
- the primary key of the lock to find
NoSuchLockException
- if a lock with the primary key could not be found
SystemException
- if a system exception occurredLock fetchByPrimaryKey(long lockId) throws SystemException
null
if it could not be found.
lockId
- the primary key of the lock to find
null
if a lock with the primary key could not be found
SystemException
- if a system exception occurredList<Lock> findByUuid(String uuid) throws SystemException
uuid
- the uuid to search with
SystemException
- if a system exception occurredList<Lock> findByUuid(String uuid, int start, int end) throws SystemException
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.
uuid
- the uuid to search withstart
- the lower bound of the range of locks to returnend
- the upper bound of the range of locks to return (not inclusive)
SystemException
- if a system exception occurredList<Lock> findByUuid(String uuid, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
uuid
- the uuid to search withstart
- the lower bound of the range of locks to returnend
- the upper bound of the range of locks to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredLock findByUuid_First(String uuid, OrderByComparator orderByComparator) throws NoSuchLockException, SystemException
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.
uuid
- the uuid to search withorderByComparator
- the comparator to order the set by
NoSuchLockException
- if a matching lock could not be found
SystemException
- if a system exception occurredLock findByUuid_Last(String uuid, OrderByComparator orderByComparator) throws NoSuchLockException, SystemException
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.
uuid
- the uuid to search withorderByComparator
- the comparator to order the set by
NoSuchLockException
- if a matching lock could not be found
SystemException
- if a system exception occurredLock[] findByUuid_PrevAndNext(long lockId, String uuid, OrderByComparator orderByComparator) throws NoSuchLockException, SystemException
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.
lockId
- the primary key of the current lockuuid
- the uuid to search withorderByComparator
- the comparator to order the set by
NoSuchLockException
- if a lock with the primary key could not be found
SystemException
- if a system exception occurredList<Lock> findByLtExpirationDate(Date expirationDate) throws SystemException
expirationDate
- the expiration date to search with
SystemException
- if a system exception occurredList<Lock> findByLtExpirationDate(Date expirationDate, int start, int end) throws SystemException
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.
expirationDate
- the expiration date to search withstart
- the lower bound of the range of locks to returnend
- the upper bound of the range of locks to return (not inclusive)
SystemException
- if a system exception occurredList<Lock> findByLtExpirationDate(Date expirationDate, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
expirationDate
- the expiration date to search withstart
- the lower bound of the range of locks to returnend
- the upper bound of the range of locks to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredLock findByLtExpirationDate_First(Date expirationDate, OrderByComparator orderByComparator) throws NoSuchLockException, SystemException
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.
expirationDate
- the expiration date to search withorderByComparator
- the comparator to order the set by
NoSuchLockException
- if a matching lock could not be found
SystemException
- if a system exception occurredLock findByLtExpirationDate_Last(Date expirationDate, OrderByComparator orderByComparator) throws NoSuchLockException, SystemException
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.
expirationDate
- the expiration date to search withorderByComparator
- the comparator to order the set by
NoSuchLockException
- if a matching lock could not be found
SystemException
- if a system exception occurredLock[] findByLtExpirationDate_PrevAndNext(long lockId, Date expirationDate, OrderByComparator orderByComparator) throws NoSuchLockException, SystemException
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.
lockId
- the primary key of the current lockexpirationDate
- the expiration date to search withorderByComparator
- the comparator to order the set by
NoSuchLockException
- if a lock with the primary key could not be found
SystemException
- if a system exception occurredLock findByC_K(String className, String key) throws NoSuchLockException, SystemException
NoSuchLockException
if it could not be found.
className
- the class name to search withkey
- the key to search with
NoSuchLockException
- if a matching lock could not be found
SystemException
- if a system exception occurredLock fetchByC_K(String className, String key) throws SystemException
null
if it could not be found. Uses the finder cache.
className
- the class name to search withkey
- the key to search with
null
if a matching lock could not be found
SystemException
- if a system exception occurredLock fetchByC_K(String className, String key, boolean retrieveFromCache) throws SystemException
null
if it could not be found, optionally using the finder cache.
className
- the class name to search withkey
- the key to search with
null
if a matching lock could not be found
SystemException
- if a system exception occurredList<Lock> findAll() throws SystemException
SystemException
- if a system exception occurredList<Lock> findAll(int start, int end) throws SystemException
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.
start
- the lower bound of the range of locks to returnend
- the upper bound of the range of locks to return (not inclusive)
SystemException
- if a system exception occurredList<Lock> findAll(int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
start
- the lower bound of the range of locks to returnend
- the upper bound of the range of locks to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredvoid removeByUuid(String uuid) throws SystemException
uuid
- the uuid to search with
SystemException
- if a system exception occurredvoid removeByLtExpirationDate(Date expirationDate) throws SystemException
expirationDate
- the expiration date to search with
SystemException
- if a system exception occurredvoid removeByC_K(String className, String key) throws NoSuchLockException, SystemException
className
- the class name to search withkey
- the key to search with
SystemException
- if a system exception occurred
NoSuchLockException
void removeAll() throws SystemException
SystemException
- if a system exception occurredint countByUuid(String uuid) throws SystemException
uuid
- the uuid to search with
SystemException
- if a system exception occurredint countByLtExpirationDate(Date expirationDate) throws SystemException
expirationDate
- the expiration date to search with
SystemException
- if a system exception occurredint countByC_K(String className, String key) throws SystemException
className
- the class name to search withkey
- the key to search with
SystemException
- if a system exception occurredint countAll() throws SystemException
SystemException
- if a system exception occurred
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |