Interface LockLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
LockLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionAdds the lock to the database.void
clear()
createLock
(long lockId) Creates a new lock with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteLock
(long lockId) Deletes the lock with the primary key from the database.deleteLock
(Lock lock) Deletes the lock 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) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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> 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.fetchLock
(long lockId) fetchLockByUuidAndCompanyId
(String uuid, long companyId) Returns the lock with the matching UUID and company.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getLock
(long lockId) Returns the lock with the primary key.getLockByUuidAndCompanyId
(String uuid, long companyId) Returns the lock with the matching UUID and company.getLocks
(int start, int end) Returns a range of all the locks.int
Returns the number of locks.Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) boolean
boolean
boolean
boolean
lock
(long userId, String className, long key, String owner, boolean inheritable, long expirationTime) lock
(long userId, String className, long key, String owner, boolean inheritable, long expirationTime, boolean renew) lock
(long userId, String className, String key, String owner, boolean inheritable, long expirationTime) lock
(long userId, String className, String key, String owner, boolean inheritable, long expirationTime, boolean renew) void
void
void
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
fetchPersistedModel, getBasePersistence
-
Method Details
-
addLock
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
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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteLock
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 interfacecom.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) - Specified by:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.lock.model.impl.LockModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.lock.model.impl.LockModelImpl
.- Parameters:
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 (optionallynull
)- 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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchLock
-
fetchLock
-
fetchLock
-
fetchLockByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Lock fetchLockByUuidAndCompanyId(String uuid, long companyId) Returns the lock with the matching UUID and company.- Parameters:
uuid
- the lock's UUIDcompanyId
- 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(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(String className, String key) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLockByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Lock getLockByUuidAndCompanyId(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 UUIDcompanyId
- 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
Returns a range of all the locks.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.lock.model.impl.LockModelImpl
.- Parameters:
start
- the lower bound of the range of locksend
- the upper bound of the range of locks (not inclusive)- Returns:
- the range of locks
-
getLocks
-
getLocks
-
getLocksCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getLocksCount()Returns the number of locks.- Returns:
- the number of locks
-
getOSGiServiceIdentifier
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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
hasLock
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasLock(long userId, String className, long key) -
hasLock
-
isLocked
-
isLocked
-
lock
Lock lock(long userId, String className, long key, 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, String className, long key, 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, String className, String key, 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, String className, String key, String owner, boolean inheritable, long expirationTime, boolean renew) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
lock
-
lock
-
refresh
Lock refresh(String uuid, long companyId, long expirationTime) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unlock
-
unlock
-
unlock
-
updateLock
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
-