|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.persistence.LockUtil
public class LockUtil
The persistence utility for the lock service. This utility wraps LockPersistenceImpl
and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.
Never modify this class directly. Modify service.xml
and rerun ServiceBuilder to regenerate this class.
Caching information and settings can be found in portal.properties
LockPersistence
,
LockPersistenceImpl
Constructor Summary | |
---|---|
LockUtil()
|
Method Summary | |
---|---|
static void |
cacheResult(List<Lock> locks)
Caches the locks in the entity cache if it is enabled. |
static void |
cacheResult(Lock lock)
Caches the lock in the entity cache if it is enabled. |
static void |
clearCache()
|
static void |
clearCache(Lock lock)
|
static int |
countAll()
Counts all the locks. |
static int |
countByC_K(String className,
String key)
Counts all the locks where className = ? and key = ?. |
static int |
countByLtExpirationDate(Date expirationDate)
Counts all the locks where expirationDate < ?. |
static int |
countByUuid(String uuid)
Counts all the locks where uuid = ?. |
long |
countWithDynamicQuery(DynamicQuery dynamicQuery)
|
static Lock |
create(long lockId)
Creates a new lock with the primary key. |
static Lock |
fetchByC_K(String className,
String key)
Finds the lock where className = ? and key = ? or returns null if it could not be found. |
static 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. |
static Lock |
fetchByPrimaryKey(long lockId)
Finds the lock with the primary key or returns null if it could not be found. |
static List<Lock> |
findAll()
Finds all the locks. |
static List<Lock> |
findAll(int start,
int end)
Finds a range of all the locks. |
static List<Lock> |
findAll(int start,
int end,
OrderByComparator orderByComparator)
Finds an ordered range of all the locks. |
static Lock |
findByC_K(String className,
String key)
Finds the lock where className = ? and key = ? or throws a NoSuchLockException if it could not be found. |
static Lock |
findByLtExpirationDate_First(Date expirationDate,
OrderByComparator orderByComparator)
Finds the first lock in the ordered set where expirationDate < ?. |
static Lock |
findByLtExpirationDate_Last(Date expirationDate,
OrderByComparator orderByComparator)
Finds the last lock in the ordered set where expirationDate < ?. |
static Lock[] |
findByLtExpirationDate_PrevAndNext(long lockId,
Date expirationDate,
OrderByComparator orderByComparator)
Finds the locks before and after the current lock in the ordered set where expirationDate < ?. |
static List<Lock> |
findByLtExpirationDate(Date expirationDate)
Finds all the locks where expirationDate < ?. |
static List<Lock> |
findByLtExpirationDate(Date expirationDate,
int start,
int end)
Finds a range of all the locks where expirationDate < ?. |
static List<Lock> |
findByLtExpirationDate(Date expirationDate,
int start,
int end,
OrderByComparator orderByComparator)
Finds an ordered range of all the locks where expirationDate < ?. |
static Lock |
findByPrimaryKey(long lockId)
Finds the lock with the primary key or throws a NoSuchLockException if it could not be found. |
static Lock |
findByUuid_First(String uuid,
OrderByComparator orderByComparator)
Finds the first lock in the ordered set where uuid = ?. |
static Lock |
findByUuid_Last(String uuid,
OrderByComparator orderByComparator)
Finds the last lock in the ordered set where uuid = ?. |
static Lock[] |
findByUuid_PrevAndNext(long lockId,
String uuid,
OrderByComparator orderByComparator)
Finds the locks before and after the current lock in the ordered set where uuid = ?. |
static List<Lock> |
findByUuid(String uuid)
Finds all the locks where uuid = ?. |
static List<Lock> |
findByUuid(String uuid,
int start,
int end)
Finds a range of all the locks where uuid = ?. |
static List<Lock> |
findByUuid(String uuid,
int start,
int end,
OrderByComparator orderByComparator)
Finds an ordered range of all the locks where uuid = ?. |
static List<Lock> |
findWithDynamicQuery(DynamicQuery dynamicQuery)
|
static List<Lock> |
findWithDynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
|
static List<Lock> |
findWithDynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
|
static LockPersistence |
getPersistence()
|
static Lock |
remove(Lock lock)
|
static Lock |
remove(long lockId)
Removes the lock with the primary key from the database. |
static void |
removeAll()
Removes all the locks from the database. |
static void |
removeByC_K(String className,
String key)
Removes the lock where className = ? and key = ? from the database. |
static void |
removeByLtExpirationDate(Date expirationDate)
Removes all the locks where expirationDate < ? from the database. |
static void |
removeByUuid(String uuid)
Removes all the locks where uuid = ? from the database. |
void |
setPersistence(LockPersistence persistence)
|
static Lock |
update(Lock lock,
boolean merge)
|
static Lock |
update(Lock lock,
boolean merge,
ServiceContext serviceContext)
|
static Lock |
updateImpl(Lock lock,
boolean merge)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LockUtil()
Method Detail |
---|
public static void clearCache()
BasePersistence.clearCache()
public static void clearCache(Lock lock)
BasePersistence.clearCache(com.liferay.portal.model.BaseModel)
public long countWithDynamicQuery(DynamicQuery dynamicQuery) throws SystemException
SystemException
BasePersistence.countWithDynamicQuery(DynamicQuery)
public static List<Lock> findWithDynamicQuery(DynamicQuery dynamicQuery) throws SystemException
SystemException
BasePersistence.findWithDynamicQuery(DynamicQuery)
public static List<Lock> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
SystemException
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)
public static List<Lock> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)
public static Lock remove(Lock lock) throws SystemException
SystemException
BasePersistence.remove(com.liferay.portal.model.BaseModel)
public static Lock update(Lock lock, boolean merge) throws SystemException
SystemException
BasePersistence.update(com.liferay.portal.model.BaseModel, boolean)
public static Lock update(Lock lock, boolean merge, ServiceContext serviceContext) throws SystemException
SystemException
BasePersistence.update(com.liferay.portal.model.BaseModel, boolean, ServiceContext)
public static void cacheResult(Lock lock)
lock
- the lock to cachepublic static void cacheResult(List<Lock> locks)
locks
- the locks to cachepublic static Lock create(long lockId)
lockId
- the primary key for the new lock
public static 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 occurredpublic static Lock updateImpl(Lock lock, boolean merge) throws SystemException
SystemException
public static 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 occurredpublic static Lock 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 occurredpublic static List<Lock> findByUuid(String uuid) throws SystemException
uuid
- the uuid to search with
SystemException
- if a system exception occurredpublic static List<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 occurredpublic static List<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 occurredpublic static Lock 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 occurredpublic static Lock 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 occurredpublic static Lock[] 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 occurredpublic static List<Lock> findByLtExpirationDate(Date expirationDate) throws SystemException
expirationDate
- the expiration date to search with
SystemException
- if a system exception occurredpublic static List<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 occurredpublic static List<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 occurredpublic static Lock 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 occurredpublic static Lock 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 occurredpublic static Lock[] 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 occurredpublic static Lock 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 occurredpublic static Lock 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 occurredpublic static Lock 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 occurredpublic static List<Lock> findAll() throws SystemException
SystemException
- if a system exception occurredpublic static List<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 occurredpublic static List<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 occurredpublic static void removeByUuid(String uuid) throws SystemException
uuid
- the uuid to search with
SystemException
- if a system exception occurredpublic static void removeByLtExpirationDate(Date expirationDate) throws SystemException
expirationDate
- the expiration date to search with
SystemException
- if a system exception occurredpublic static void 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
public static void removeAll() throws SystemException
SystemException
- if a system exception occurredpublic static int countByUuid(String uuid) throws SystemException
uuid
- the uuid to search with
SystemException
- if a system exception occurredpublic static int countByLtExpirationDate(Date expirationDate) throws SystemException
expirationDate
- the expiration date to search with
SystemException
- if a system exception occurredpublic static int 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 occurredpublic static int countAll() throws SystemException
SystemException
- if a system exception occurredpublic static LockPersistence getPersistence()
public void setPersistence(LockPersistence persistence)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |