Liferay 6.1.2-ce-ga3

com.liferay.portal.service.persistence
Class LockUtil

java.lang.Object
  extended by com.liferay.portal.service.persistence.LockUtil

public class LockUtil
extends Object

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.

Caching information and settings can be found in portal.properties

See Also:
LockPersistence, LockPersistenceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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

LockUtil

public LockUtil()
Method Detail

clearCache

public static void clearCache()
See Also:
BasePersistence.clearCache()

clearCache

public static void clearCache(Lock lock)
See Also:
BasePersistence.clearCache(com.liferay.portal.model.BaseModel)

countWithDynamicQuery

public long countWithDynamicQuery(DynamicQuery dynamicQuery)
                           throws SystemException
Throws:
SystemException
See Also:
BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Lock> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                       throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Lock> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                              int start,
                                              int end)
                                       throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<Lock> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                              int start,
                                              int end,
                                              OrderByComparator orderByComparator)
                                       throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static Lock update(Lock lock,
                          boolean merge)
                   throws SystemException
Throws:
SystemException
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel, boolean)

update

public static Lock update(Lock lock,
                          boolean merge,
                          ServiceContext serviceContext)
                   throws SystemException
Throws:
SystemException
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel, boolean, ServiceContext)

cacheResult

public static void cacheResult(Lock lock)
Caches the lock in the entity cache if it is enabled.

Parameters:
lock - the lock

cacheResult

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

Parameters:
locks - the locks

create

public static 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

public static 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

public static Lock updateImpl(Lock lock,
                              boolean merge)
                       throws SystemException
Throws:
SystemException

findByPrimaryKey

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static List<Lock> findAll()
                          throws SystemException
Returns all the locks.

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

findAll

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static void removeAll()
                      throws SystemException
Removes all the locks from the database.

Throws:
SystemException - if a system exception occurred

countByUuid

public static 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

public static 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

public static 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

public static 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

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

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

getPersistence

public static LockPersistence getPersistence()

setPersistence

public void setPersistence(LockPersistence persistence)
Deprecated. 


Liferay 6.1.2-ce-ga3