|
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.LockLocalServiceUtil
public class LockLocalServiceUtil
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.
LockLocalService
,
LockLocalServiceBaseImpl
,
LockLocalServiceImpl
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 |
---|
public LockLocalServiceUtil()
Method Detail |
---|
public static Lock addLock(Lock lock) throws SystemException
lock
- the lock to add
SystemException
- if a system exception occurredpublic static Lock createLock(long lockId)
lockId
- the primary key for the new lock
public static void deleteLock(long lockId) throws PortalException, SystemException
lockId
- the primary key of the lock to delete
PortalException
- if a lock with the primary key could not be found
SystemException
- if a system exception occurredpublic static void deleteLock(Lock lock) throws SystemException
lock
- the lock to delete
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, 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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, 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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static Lock getLock(long lockId) throws PortalException, SystemException
lockId
- the primary key of the lock to get
PortalException
- if a lock with the primary key could not be found
SystemException
- if a system exception occurredpublic static List<Lock> getLocks(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 int getLocksCount() throws SystemException
SystemException
- if a system exception occurredpublic static Lock updateLock(Lock lock) throws SystemException
lock
- the lock to update
SystemException
- if a system exception occurredpublic static Lock updateLock(Lock lock, boolean merge) throws SystemException
lock
- the lock to updatemerge
- 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.
SystemException
- if a system exception occurredpublic static void clear() throws SystemException
SystemException
public static Lock getLock(String className, long key) throws PortalException, SystemException
PortalException
SystemException
public static Lock getLock(String className, String key) throws PortalException, SystemException
PortalException
SystemException
public static boolean hasLock(long userId, String className, long key) throws PortalException, SystemException
PortalException
SystemException
public static boolean hasLock(long userId, String className, String key) throws PortalException, SystemException
PortalException
SystemException
public static boolean isLocked(String className, long key) throws PortalException, SystemException
PortalException
SystemException
public static boolean isLocked(String className, String key) throws PortalException, SystemException
PortalException
SystemException
public static Lock lock(long userId, String className, long key, String owner, boolean inheritable, long expirationTime) throws PortalException, SystemException
PortalException
SystemException
public static Lock lock(long userId, String className, String key, String owner, boolean inheritable, long expirationTime) throws PortalException, SystemException
PortalException
SystemException
public static Lock refresh(String uuid, long expirationTime) throws PortalException, SystemException
PortalException
SystemException
public static void unlock(String className, long key) throws SystemException
SystemException
public static void unlock(String className, String key) throws SystemException
SystemException
public static LockLocalService getService()
public void setService(LockLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |