Package org.ametys.plugins.repository.lock

Interface LockableAmetysObject

All Superinterfaces:

AmetysObject, DataHolder, LockAwareAmetysObject

All Known Subinterfaces:

ModifiableResource

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, Course, CourseList, CoursePart, DefaultLockableAmetysObject, File, JCRResource, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, SubProgram

public interface LockableAmetysObject
extends LockAwareAmetysObject

AmetysObject that can be locked.

Method Summary

Modifier and Type	Method	Description
void	lock()	Locks this AmetysObject
void	setLockInfoOnCurrentContext()	Sets a lock info on the current context for this object
void	unlock()	Unlocks this AmetysObject

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.lock.LockAwareAmetysObject

getLockOwner, isLocked

Method Details

lock

void lock()
   throws AmetysRepositoryException

Locks this AmetysObject

Throws:

AmetysRepositoryException - if a problem occurs

unlock

void unlock()
     throws AmetysRepositoryException

Unlocks this AmetysObject

Throws:

AmetysRepositoryException - if a problem occurs

setLockInfoOnCurrentContext

void setLockInfoOnCurrentContext()
                          throws AmetysRepositoryException

Sets a lock info on the current context for this object

Throws:

AmetysRepositoryException - if an error occurs