com.liferay.portal.service
Interface LockLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

LockLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LockLocalService
extends BaseLocalService, 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, LockLocalServiceBaseImpl, com.liferay.portal.service.impl.LockLocalServiceImpl

Method Summary

Lock	addLock(Lock lock) Adds the lock to the database.
void	clear()
Lock	createLock(long lockId) Creates a new lock with the primary key.
Lock	deleteLock(Lock lock) Deletes the lock from the database.
Lock	deleteLock(long lockId) Deletes the lock with the primary key from the database.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
Lock	fetchLock(long lockId)
Lock	fetchLockByUuidAndCompanyId(String uuid, long companyId) Returns the lock with the matching UUID and company.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
Lock	getLock(long lockId) Returns the lock with the primary key.
Lock	getLock(String className, long key)
Lock	getLock(String className, String key)
Lock	getLockByUuidAndCompanyId(String uuid, long companyId) Returns the lock with the matching UUID and company.
List<Lock>	getLocks(int start, int end) Returns a range of all the locks.
int	getLocksCount() Returns the number of locks.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
boolean	hasLock(long userId, String className, long key)
boolean	hasLock(long userId, String className, String key)
boolean	isLocked(String className, long key)
boolean	isLocked(String className, String key)
Lock	lock(long userId, String className, long key, String owner, boolean inheritable, long expirationTime)
Lock	lock(long userId, String className, String key, String owner, boolean inheritable, long expirationTime)
Lock	lock(String className, String key, String owner)
Lock	lock(String className, String key, String owner, boolean retrieveFromCache) Deprecated. As of 6.2.0, replaced by lock(String, String, String)
Lock	lock(String className, String key, String expectedOwner, String updatedOwner)
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)
Lock	refresh(String uuid, long companyId, long expirationTime)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	unlock(String className, long key)
void	unlock(String className, String key)
void	unlock(String className, String key, String owner)
void	unlock(String className, String key, String owner, boolean retrieveFromCache) Deprecated. As of 6.2.0, replaced by unlock(String, String, String)
Lock	updateLock(Lock lock) Updates the lock in the database or adds it if it does not yet exist.

Method Detail

addLock

@Indexable(type=REINDEX)
Lock addLock(Lock lock)
             throws SystemException

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

Parameters:

lock - the lock

Returns:

the lock that was added

Throws:

SystemException - if a system exception occurred

createLock

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

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

Returns:

the lock that was removed

Throws:

PortalException - if a lock with the primary key could not be found

SystemException - if a system exception occurred

deleteLock

@Indexable(type=DELETE)
Lock deleteLock(Lock lock)
                throws SystemException

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

Parameters:

lock - the lock

Returns:

the lock that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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. 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

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. 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchLock

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

Throws:

SystemException

fetchLockByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock fetchLockByUuidAndCompanyId(String uuid,
                                                                          long companyId)
                                 throws SystemException

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

Throws:

SystemException - if a system exception occurred

getLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getLock(long lockId)
             throws PortalException,
                    SystemException

Returns the lock with the primary key.

Parameters:

lockId - the primary key of the lock

Returns:

the lock

Throws:

PortalException - if a lock with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getLockByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getLockByUuidAndCompanyId(String uuid,
                                                                        long companyId)
                               throws PortalException,
                                      SystemException

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:

PortalException - if a matching lock could not be found

SystemException - if a system exception occurred

getLocks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Lock> getLocks(int start,
                                                             int end)
                    throws SystemException

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 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.

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

Throws:

SystemException - if a system exception occurred

getLocksCount

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

Returns the number of locks.

Returns:

the number of locks

Throws:

SystemException - if a system exception occurred

updateLock

@Indexable(type=REINDEX)
Lock updateLock(Lock lock)
                throws SystemException

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

Parameters:

lock - the lock

Returns:

the lock that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

clear

void clear()
           throws SystemException

Throws:

SystemException

getLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getLock(String className,
                                                      long key)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

getLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getLock(String className,
                                                      String key)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

hasLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLock(long userId,
                                                         String className,
                                                         long key)
                throws SystemException

Throws:

SystemException

hasLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLock(long userId,
                                                         String className,
                                                         String key)
                throws SystemException

Throws:

SystemException

isLocked

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isLocked(String className,
                                                          long key)
                 throws SystemException

Throws:

SystemException

isLocked

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isLocked(String className,
                                                          String key)
                 throws SystemException

Throws:

SystemException

lock

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

Throws:

PortalException

SystemException

lock

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

Throws:

PortalException

SystemException

lock

@MasterDataSource
@Transactional(propagation=REQUIRES_NEW)
Lock lock(String className,
                                                                String key,
                                                                String owner)
          throws SystemException

Throws:

SystemException

lock

@MasterDataSource
@Transactional(propagation=REQUIRES_NEW)
Lock lock(String className,
                                                                String key,
                                                                String owner,
                                                                boolean retrieveFromCache)
          throws SystemException

Deprecated. As of 6.2.0, replaced by lock(String, String, String)

Throws:

SystemException

lock

@MasterDataSource
@Transactional(propagation=REQUIRES_NEW)
Lock lock(String className,
                                                                String key,
                                                                String expectedOwner,
                                                                String updatedOwner)
          throws SystemException

Throws:

SystemException

lock

@MasterDataSource
@Transactional(propagation=REQUIRES_NEW)
Lock lock(String className,
                                                                String key,
                                                                String expectedOwner,
                                                                String updatedOwner,
                                                                boolean retrieveFromCache)
          throws SystemException

Deprecated. As of 6.2.0, replaced by lock(String, String, String, String)

Throws:

SystemException

refresh

Lock refresh(String uuid,
             long companyId,
             long expirationTime)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

unlock

void unlock(String className,
            long key)
            throws SystemException

Throws:

SystemException

unlock

void unlock(String className,
            String key)
            throws SystemException

Throws:

SystemException

unlock

@MasterDataSource
@Transactional(propagation=REQUIRES_NEW)
void unlock(String className,
                                                                  String key,
                                                                  String owner)
            throws SystemException

Throws:

SystemException

unlock

@MasterDataSource
@Transactional(propagation=REQUIRES_NEW)
void unlock(String className,
                                                                  String key,
                                                                  String owner,
                                                                  boolean retrieveFromCache)
            throws SystemException

Deprecated. As of 6.2.0, replaced by unlock(String, String, String)

Throws:

SystemException