Liferay 6.0.5

com.liferay.portal.service
Class LockLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.LockLocalServiceUtil

public class LockLocalServiceUtil
extends Object

The utility for the lock local service. This utility wraps LockLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to LockLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
LockLocalService, LockLocalServiceBaseImpl, LockLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
LockLocalServiceUtil()
           
 
Method Summary
static Lock addLock(Lock lock)
          Adds the lock to the database.
static void clear()
           
static Lock createLock(long lockId)
          Creates a new lock with the primary key.
static void deleteLock(Lock lock)
          Deletes the lock from the database.
static void deleteLock(long lockId)
          Deletes the lock with the primary key from the database.
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
static Lock getLock(long lockId)
          Gets the lock with the primary key.
static Lock getLock(String className, long key)
           
static Lock getLock(String className, String key)
           
static List<Lock> getLocks(int start, int end)
          Gets a range of all the locks.
static int getLocksCount()
          Gets the number of locks.
static LockLocalService getService()
           
static boolean hasLock(long userId, String className, long key)
           
static boolean hasLock(long userId, String className, String key)
           
static boolean isLocked(String className, long key)
           
static boolean isLocked(String className, String key)
           
static Lock lock(long userId, String className, long key, String owner, boolean inheritable, long expirationTime)
           
static Lock lock(long userId, String className, String key, String owner, boolean inheritable, long expirationTime)
           
static Lock refresh(String uuid, long expirationTime)
           
 void setService(LockLocalService service)
           
static void unlock(String className, long key)
           
static void unlock(String className, String key)
           
static Lock updateLock(Lock lock)
          Updates the lock in the database.
static Lock updateLock(Lock lock, boolean merge)
          Updates the lock in the database.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LockLocalServiceUtil

public LockLocalServiceUtil()
Method Detail

addLock

public static Lock addLock(Lock lock)
                    throws SystemException
Adds the lock to the database. Also notifies the appropriate model listeners.

Parameters:
lock - the lock to add
Returns:
the lock that was added
Throws:
SystemException - if a system exception occurred

createLock

public static Lock createLock(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

deleteLock

public static void deleteLock(long lockId)
                       throws PortalException,
                              SystemException
Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
lockId - the primary key of the lock to delete
Throws:
PortalException - if a lock with the primary key could not be found
SystemException - if a system exception occurred

deleteLock

public static void deleteLock(Lock lock)
                       throws SystemException
Deletes the lock from the database. Also notifies the appropriate model listeners.

Parameters:
lock - the lock to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

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:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

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:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getLock

public static Lock getLock(long lockId)
                    throws PortalException,
                           SystemException
Gets the lock with the primary key.

Parameters:
lockId - the primary key of the lock to get
Returns:
the lock
Throws:
PortalException - if a lock with the primary key could not be found
SystemException - if a system exception occurred

getLocks

public static List<Lock> getLocks(int start,
                                  int end)
                           throws SystemException
Gets 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

getLocksCount

public static int getLocksCount()
                         throws SystemException
Gets the number of locks.

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

updateLock

public static Lock updateLock(Lock lock)
                       throws SystemException
Updates the lock in the database. Also notifies the appropriate model listeners.

Parameters:
lock - the lock to update
Returns:
the lock that was updated
Throws:
SystemException - if a system exception occurred

updateLock

public static Lock updateLock(Lock lock,
                              boolean merge)
                       throws SystemException
Updates the lock in the database. Also notifies the appropriate model listeners.

Parameters:
lock - the lock to update
merge - whether to merge the lock with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the lock that was updated
Throws:
SystemException - if a system exception occurred

clear

public static void clear()
                  throws SystemException
Throws:
SystemException

getLock

public static Lock getLock(String className,
                           long key)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getLock

public static Lock getLock(String className,
                           String key)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

hasLock

public static boolean hasLock(long userId,
                              String className,
                              long key)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

hasLock

public static boolean hasLock(long userId,
                              String className,
                              String key)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

isLocked

public static boolean isLocked(String className,
                               long key)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

isLocked

public static boolean isLocked(String className,
                               String key)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

lock

public static Lock lock(long userId,
                        String className,
                        long key,
                        String owner,
                        boolean inheritable,
                        long expirationTime)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

lock

public static Lock lock(long userId,
                        String className,
                        String key,
                        String owner,
                        boolean inheritable,
                        long expirationTime)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

refresh

public static Lock refresh(String uuid,
                           long expirationTime)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

unlock

public static void unlock(String className,
                          long key)
                   throws SystemException
Throws:
SystemException

unlock

public static void unlock(String className,
                          String key)
                   throws SystemException
Throws:
SystemException

getService

public static LockLocalService getService()

setService

public void setService(LockLocalService service)

Liferay 6.0.5