com.liferay.portal.service
Interface LockLocalService

All Known Implementing Classes:

LockLocalServiceBaseImpl, LockLocalServiceImpl, LockLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LockLocalService

The interface for the lock local service.

Never modify or reference this interface directly. Always use LockLocalServiceUtil to access the lock local service. Add custom service methods to LockLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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.

See Also:

LockLocalServiceUtil, LockLocalServiceBaseImpl, LockLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

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.
void	deleteLock(Lock lock) Deletes the lock from the database.
void	deleteLock(long lockId) Deletes the lock with the primary key from the database.
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) Counts the number of rows that match the dynamic query.
Lock	getLock(long lockId) Gets the lock with the primary key.
Lock	getLock(String className, long key)
Lock	getLock(String className, String key)
List<Lock>	getLocks(int start, int end) Gets a range of all the locks.
int	getLocksCount() Gets the number of locks.
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	refresh(String uuid, long expirationTime)
void	unlock(String className, long key)
void	unlock(String className, String key)
Lock	updateLock(Lock lock) Updates the lock in the database.
Lock	updateLock(Lock lock, boolean merge) Updates the lock in the database.

Method Detail

addLock

Lock addLock(Lock lock)
             throws SystemException

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

Parameters:

lock - the lock to add

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

void 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 to delete

Throws:

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

SystemException - if a system exception occurred

deleteLock

void deleteLock(Lock lock)
                throws SystemException

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

Parameters:

lock - the lock to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getLock

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

Gets the lock with the primary key.

Parameters:

lockId - the primary key of the lock to get

Returns:

the lock

Throws:

PortalException - if a lock with the primary key 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

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

Parameters:

start - the lower bound of the range of locks to return

end - the upper bound of the range of locks to return (not inclusive)

Returns:

the range of locks

Throws:

SystemException - if a system exception occurred

getLocksCount

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

Gets the number of locks.

Returns:

the number of locks

Throws:

SystemException - if a system exception occurred

updateLock

Lock updateLock(Lock lock)
                throws SystemException

Updates the lock in the database. Also notifies the appropriate model listeners.

Parameters:

lock - the lock to update

Returns:

the lock that was updated

Throws:

SystemException - if a system exception occurred

updateLock

Lock updateLock(Lock lock,
                boolean merge)
                throws SystemException

Updates the lock in the database. Also notifies the appropriate model listeners.

Parameters:

lock - the lock to update

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

Returns:

the lock that was updated

Throws:

SystemException - if a system exception occurred

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 PortalException,
                       SystemException

Throws:

PortalException

SystemException

hasLock

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

Throws:

PortalException

SystemException

isLocked

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

Throws:

PortalException

SystemException

isLocked

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

Throws:

PortalException

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

refresh

Lock refresh(String uuid,
             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