|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for finding and maintaining IEntityLocks
.
Method Summary | |
void |
add(IEntityLock lock)
Adds this IEntityLock to the store. |
void |
delete(IEntityLock lock)
Deletes this IEntityLock from the store. |
void |
deleteAll()
Delete all IEntityLocks from the store. |
void |
deleteExpired(java.util.Date expiration)
Deletes the expired IEntityLocks from the underlying store. |
IEntityLock[] |
find(java.lang.Class entityType,
java.lang.String entityKey,
java.lang.Integer lockType,
java.util.Date expiration,
java.lang.String lockOwner)
Returns an IEntityLock[] based on the params, any or all of which may be null. |
IEntityLock[] |
findUnexpired(java.util.Date expiration,
java.lang.Class entityType,
java.lang.String entityKey,
java.lang.Integer lockType,
java.lang.String lockOwner)
Returns an IEntityLock[] containing unexpired locks, based on the params, any or all of which may be null EXCEPT FOR expiration . |
void |
update(IEntityLock lock,
java.util.Date newExpiration)
Updates the lock's expiration in the underlying store. |
void |
update(IEntityLock lock,
java.util.Date newExpiration,
java.lang.Integer newLockType)
Updates the lock's expiration and lockType in the
underlying store. |
Method Detail |
public void add(IEntityLock lock) throws LockingException
lock
- org.jasig.portal.concurrency.locking.IEntityLock
LockingException
public void delete(IEntityLock lock) throws LockingException
lock
- org.jasig.portal.concurrency.locking.IEntityLock
LockingException
public void deleteAll() throws LockingException
LockingException
public void deleteExpired(java.util.Date expiration) throws LockingException
expiration
- java.util.Date
LockingException
public IEntityLock[] find(java.lang.Class entityType, java.lang.String entityKey, java.lang.Integer lockType, java.util.Date expiration, java.lang.String lockOwner) throws LockingException
find(myType,myKey,null,null,null)
will return all IEntityLocks
for myType and myKey.
entityType
- ClassentityKey
- StringlockType
- Integer - so we can accept a null value.expiration
- DatelockOwner
- String
LockingException
- - wraps an Exception specific to the store.public IEntityLock[] findUnexpired(java.util.Date expiration, java.lang.Class entityType, java.lang.String entityKey, java.lang.Integer lockType, java.lang.String lockOwner) throws LockingException
expiration
. A null
param means any value, so find(expir,myType,myKey,null,null)
will return all IEntityLocks
for myType and myKey unexpired
as of expiration
.
expiration
- DateentityType
- ClassentityKey
- StringlockType
- Integer - so we can accept a null value.lockOwner
- String
LockingException
- - wraps an Exception specific to the store.public void update(IEntityLock lock, java.util.Date newExpiration) throws LockingException
expiration
in the underlying store.
lock
- org.jasig.portal.concurrency.locking.IEntityLocknewExpiration
- java.util.Date
LockingException
public void update(IEntityLock lock, java.util.Date newExpiration, java.lang.Integer newLockType) throws LockingException
expiration
and lockType
in the
underlying store. Param lockType
may be null.
lock
- org.jasig.portal.concurrency.locking.IEntityLocknewExpiration
- java.util.DatenewLockType
- Integer
LockingException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |