com.liferay.portal.lock.service

Class LockLocalServiceUtil

java.lang.Object

com.liferay.portal.lock.service.LockLocalServiceUtil

public class LockLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Lock. This utility wraps com.liferay.portal.lock.service.impl.LockLocalServiceImpl and is an 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.

See Also:

LockLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
LockLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
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 com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
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 com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static Lock	fetchLock(long lockId)
static Lock	fetchLock(java.lang.String className, long key)
static Lock	fetchLock(java.lang.String className, java.lang.String key)
static Lock	fetchLockByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the lock with the matching UUID and company.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static Lock	getLock(long lockId) Returns the lock with the primary key.
static Lock	getLock(java.lang.String className, long key)
static Lock	getLock(java.lang.String className, java.lang.String key)
static Lock	getLockByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the lock with the matching UUID and company.
static java.util.List<Lock>	getLocks(int start, int end) Returns a range of all the locks.
static int	getLocksCount() Returns the number of locks.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static LockLocalService	getService()
static boolean	hasLock(long userId, java.lang.String className, long key)
static boolean	hasLock(long userId, java.lang.String className, java.lang.String key)
static boolean	isLocked(java.lang.String className, long key)
static boolean	isLocked(java.lang.String className, java.lang.String key)
static Lock	lock(long userId, java.lang.String className, long key, java.lang.String owner, boolean inheritable, long expirationTime)
static Lock	lock(long userId, java.lang.String className, long key, java.lang.String owner, boolean inheritable, long expirationTime, boolean renew)
static Lock	lock(long userId, java.lang.String className, java.lang.String key, java.lang.String owner, boolean inheritable, long expirationTime)
static Lock	lock(long userId, java.lang.String className, java.lang.String key, java.lang.String owner, boolean inheritable, long expirationTime, boolean renew)
static Lock	lock(java.lang.String className, java.lang.String key, java.lang.String owner)
static Lock	lock(java.lang.String className, java.lang.String key, java.lang.String expectedOwner, java.lang.String updatedOwner)
static Lock	refresh(java.lang.String uuid, long companyId, long expirationTime)
static void	unlock(java.lang.String className, long key)
static void	unlock(java.lang.String className, java.lang.String key)
static void	unlock(java.lang.String className, java.lang.String key, java.lang.String owner)
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

LockLocalServiceUtil

public LockLocalServiceUtil()

Method Detail

addLock

public static Lock addLock(Lock lock)

Adds the lock to the database. Also notifies the appropriate model listeners.

Important: Inspect LockLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

lock - the lock

Returns:

the lock that was added

clear

public static void clear()

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

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteLock

public static Lock deleteLock(Lock lock)

Deletes the lock from the database. Also notifies the appropriate model listeners.

Important: Inspect LockLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

lock - the lock

Returns:

the lock that was removed

deleteLock

public static Lock deleteLock(long lockId)
                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect LockLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

lockId - the primary key of the lock

Returns:

the lock that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a lock with the primary key could not be found

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.lock.model.impl.LockModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.lock.model.impl.LockModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchLock

public static Lock fetchLock(long lockId)

fetchLock

public static Lock fetchLock(java.lang.String className,
                             long key)

fetchLock

public static Lock fetchLock(java.lang.String className,
                             java.lang.String key)

fetchLockByUuidAndCompanyId

public static Lock fetchLockByUuidAndCompanyId(java.lang.String uuid,
                                               long companyId)

Returns the lock with the matching UUID and company.

Parameters:

uuid - the lock's UUID

companyId - the primary key of the company

Returns:

the matching lock, or null if a matching lock could not be found

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLock

public static Lock getLock(long lockId)
                    throws com.liferay.portal.kernel.exception.PortalException

Returns the lock with the primary key.

Parameters:

lockId - the primary key of the lock

Returns:

the lock

Throws:

com.liferay.portal.kernel.exception.PortalException - if a lock with the primary key could not be found

getLock

public static Lock getLock(java.lang.String className,
                           long key)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getLock

public static Lock getLock(java.lang.String className,
                           java.lang.String key)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getLockByUuidAndCompanyId

public static Lock getLockByUuidAndCompanyId(java.lang.String uuid,
                                             long companyId)
                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the lock with the matching UUID and company.

Parameters:

uuid - the lock's UUID

companyId - the primary key of the company

Returns:

the matching lock

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching lock could not be found

getLocks

public static java.util.List<Lock> getLocks(int start,
                                            int end)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.lock.model.impl.LockModelImpl.

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

getLocksCount

public static int getLocksCount()

Returns the number of locks.

Returns:

the number of locks

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

hasLock

public static boolean hasLock(long userId,
                              java.lang.String className,
                              long key)

hasLock

public static boolean hasLock(long userId,
                              java.lang.String className,
                              java.lang.String key)

isLocked

public static boolean isLocked(java.lang.String className,
                               long key)

isLocked

public static boolean isLocked(java.lang.String className,
                               java.lang.String key)

lock

public static Lock lock(long userId,
                        java.lang.String className,
                        long key,
                        java.lang.String owner,
                        boolean inheritable,
                        long expirationTime)
                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

lock

public static Lock lock(long userId,
                        java.lang.String className,
                        long key,
                        java.lang.String owner,
                        boolean inheritable,
                        long expirationTime,
                        boolean renew)
                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

lock

public static Lock lock(long userId,
                        java.lang.String className,
                        java.lang.String key,
                        java.lang.String owner,
                        boolean inheritable,
                        long expirationTime)
                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

lock

public static Lock lock(long userId,
                        java.lang.String className,
                        java.lang.String key,
                        java.lang.String owner,
                        boolean inheritable,
                        long expirationTime,
                        boolean renew)
                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

lock

public static Lock lock(java.lang.String className,
                        java.lang.String key,
                        java.lang.String owner)

lock

public static Lock lock(java.lang.String className,
                        java.lang.String key,
                        java.lang.String expectedOwner,
                        java.lang.String updatedOwner)

refresh

public static Lock refresh(java.lang.String uuid,
                           long companyId,
                           long expirationTime)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

unlock

public static void unlock(java.lang.String className,
                          long key)

unlock

public static void unlock(java.lang.String className,
                          java.lang.String key)

unlock

public static void unlock(java.lang.String className,
                          java.lang.String key,
                          java.lang.String owner)

updateLock

public static Lock updateLock(Lock lock)

Updates the lock in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect LockLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

lock - the lock

Returns:

the lock that was updated

getService

public static LockLocalService getService()