com.liferay.portal.lock.service

Interface LockLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

LockLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface LockLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for Lock. 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:

LockLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
Lock	addLock(Lock lock) Adds the lock to the database.
void	clear()
Lock	createLock(long lockId) Creates a new lock with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
Lock	deleteLock(Lock lock) Deletes the lock from the database.
Lock	deleteLock(long lockId) Deletes the lock with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
Lock	fetchLock(long lockId)
Lock	fetchLock(java.lang.String className, long key)
Lock	fetchLock(java.lang.String className, java.lang.String key)
Lock	fetchLockByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the lock with the matching UUID and company.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
Lock	getLock(long lockId) Returns the lock with the primary key.
Lock	getLock(java.lang.String className, long key)
Lock	getLock(java.lang.String className, java.lang.String key)
Lock	getLockByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the lock with the matching UUID and company.
java.util.List<Lock>	getLocks(int start, int end) Returns a range of all the locks.
int	getLocksCount() Returns the number of locks.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
boolean	hasLock(long userId, java.lang.String className, long key)
boolean	hasLock(long userId, java.lang.String className, java.lang.String key)
boolean	isLocked(java.lang.String className, long key)
boolean	isLocked(java.lang.String className, java.lang.String key)
Lock	lock(long userId, java.lang.String className, long key, java.lang.String owner, boolean inheritable, long expirationTime)
Lock	lock(long userId, java.lang.String className, long key, java.lang.String owner, boolean inheritable, long expirationTime, boolean renew)
Lock	lock(long userId, java.lang.String className, java.lang.String key, java.lang.String owner, boolean inheritable, long expirationTime)
Lock	lock(long userId, java.lang.String className, java.lang.String key, java.lang.String owner, boolean inheritable, long expirationTime, boolean renew)
Lock	lock(java.lang.String className, java.lang.String key, java.lang.String owner)
Lock	lock(java.lang.String className, java.lang.String key, java.lang.String expectedOwner, java.lang.String updatedOwner)
Lock	refresh(java.lang.String uuid, long companyId, long expirationTime)
void	unlock(java.lang.String className, long key)
void	unlock(java.lang.String className, java.lang.String key)
void	unlock(java.lang.String className, java.lang.String key, java.lang.String owner)
Lock	updateLock(Lock lock) Updates the lock in the database or adds it if it does not yet exist.

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addLock

@Indexable(type=REINDEX)
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

void clear()

createLock

@Transactional(enabled=false)
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

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

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteLock

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

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

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock fetchLock(long lockId)

fetchLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock fetchLock(java.lang.String className,
                                                                                  long key)

fetchLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock fetchLock(java.lang.String className,
                                                                                  java.lang.String key)

fetchLockByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getLock(java.lang.String className,
                                                                                long key)
                                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLocksCount()

Returns the number of locks.

Returns:

the number of locks

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

hasLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLock(long userId,
                                                                                   java.lang.String className,
                                                                                   long key)

hasLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLock(long userId,
                                                                                   java.lang.String className,
                                                                                   java.lang.String key)

isLocked

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isLocked(java.lang.String className,
                                                                                    long key)

isLocked

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isLocked(java.lang.String className,
                                                                                    java.lang.String key)

lock

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

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

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

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

@MasterDataSource
Lock lock(java.lang.String className,
                            java.lang.String key,
                            java.lang.String owner)

lock

@MasterDataSource
Lock lock(java.lang.String className,
                            java.lang.String key,
                            java.lang.String expectedOwner,
                            java.lang.String updatedOwner)

refresh

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

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

unlock

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

unlock

@MasterDataSource
void unlock(java.lang.String className,
                              java.lang.String key,
                              java.lang.String owner)

updateLock

@Indexable(type=REINDEX)
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