|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.LockLocalServiceUtil
@ProviderType public class LockLocalServiceUtil
Provides the local service utility for Lock. This utility wraps
com.liferay.portal.service.impl.LockLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. 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,
com.liferay.portal.service.impl.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 Lock |
deleteLock(Lock lock)
Deletes the lock from the database. |
|
static Lock |
deleteLock(long lockId)
Deletes the lock with the primary key from the database. |
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static Lock |
fetchLock(long lockId)
|
|
static Lock |
fetchLockByUuidAndCompanyId(String uuid,
long companyId)
Returns the lock with the matching UUID and company. |
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
|
static Lock |
getLock(long lockId)
Returns the lock with the primary key. |
|
static Lock |
getLock(String className,
long key)
|
|
static Lock |
getLock(String className,
String key)
|
|
static Lock |
getLockByUuidAndCompanyId(String uuid,
long companyId)
Returns the lock with the matching UUID and company. |
|
static List<Lock> |
getLocks(int start,
int end)
Returns a range of all the locks. |
|
static int |
getLocksCount()
Returns the number of locks. |
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
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 |
lock(String className,
String key,
String owner)
|
|
static Lock |
lock(String className,
String key,
String owner,
boolean retrieveFromCache)
Deprecated. As of 6.2.0, replaced by lock(String, String,
String) |
|
static Lock |
lock(String className,
String key,
String expectedOwner,
String updatedOwner)
|
|
static Lock |
lock(String className,
String key,
String expectedOwner,
String updatedOwner,
boolean retrieveFromCache)
Deprecated. As of 6.2.0, replaced by lock(String, String, String,
String) |
|
static Lock |
refresh(String uuid,
long companyId,
long expirationTime)
|
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
|
void |
setService(LockLocalService service)
Deprecated. As of 6.2.0 |
|
static void |
unlock(String className,
long key)
|
|
static void |
unlock(String className,
String key)
|
|
static void |
unlock(String className,
String key,
String owner)
|
|
static void |
unlock(String className,
String key,
String owner,
boolean retrieveFromCache)
Deprecated. As of 6.2.0, replaced by unlock(String, String,
String) |
|
static Lock |
updateLock(Lock lock)
Updates the lock in the database or adds it if it does not yet exist. |
|
| 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)
lock - the lock
public static void clear()
public static Lock createLock(long lockId)
lockId - the primary key for the new lock
public static Lock deleteLock(Lock lock)
lock - the lock
public static Lock deleteLock(long lockId)
throws PortalException
lockId - the primary key of the lock
PortalException - if a lock with the primary key could not be found
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LockModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LockModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static Lock fetchLock(long lockId)
public static Lock fetchLockByUuidAndCompanyId(String uuid,
long companyId)
uuid - the lock's UUIDcompanyId - the primary key of the company
null if a matching lock could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static String getBeanIdentifier()
public static Lock getLock(String className,
long key)
throws PortalException
PortalException
public static Lock getLock(String className,
String key)
throws PortalException
PortalException
public static Lock getLock(long lockId)
throws PortalException
lockId - the primary key of the lock
PortalException - if a lock with the primary key could not be found
public static Lock getLockByUuidAndCompanyId(String uuid,
long companyId)
throws PortalException
uuid - the lock's UUIDcompanyId - the primary key of the company
PortalException - if a matching lock could not be found
public static List<Lock> getLocks(int start,
int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LockModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start - the lower bound of the range of locksend - the upper bound of the range of locks (not inclusive)
public static int getLocksCount()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static boolean hasLock(long userId,
String className,
String key)
public static boolean hasLock(long userId,
String className,
long key)
public static boolean isLocked(String className,
String key)
public static boolean isLocked(String className,
long key)
public static Lock lock(String className,
String key,
String expectedOwner,
String updatedOwner)
@Deprecated
public static Lock lock(String className,
String key,
String expectedOwner,
String updatedOwner,
boolean retrieveFromCache)
lock(String, String, String,
String)
public static Lock lock(String className,
String key,
String owner)
@Deprecated
public static Lock lock(String className,
String key,
String owner,
boolean retrieveFromCache)
lock(String, String,
String)
public static Lock lock(long userId,
String className,
String key,
String owner,
boolean inheritable,
long expirationTime)
throws PortalException
PortalException
public static Lock lock(long userId,
String className,
long key,
String owner,
boolean inheritable,
long expirationTime)
throws PortalException
PortalException
public static Lock refresh(String uuid,
long companyId,
long expirationTime)
throws PortalException
PortalExceptionpublic static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
public static void unlock(String className,
long key)
public static void unlock(String className,
String key)
public static void unlock(String className,
String key,
String owner)
@Deprecated
public static void unlock(String className,
String key,
String owner,
boolean retrieveFromCache)
unlock(String, String,
String)
public static Lock updateLock(Lock lock)
lock - the lock
public static LockLocalService getService()
@Deprecated public void setService(LockLocalService service)
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||