Package org.ametys.plugins.repository.lock

Interface LockAwareAmetysObject

All Superinterfaces:

AmetysObject, DataHolder

All Known Subinterfaces:

LockableAmetysObject, ModifiableResource

All Known Implementing Classes:

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

public interface LockAwareAmetysObject
extends AmetysObject

AmetysObject that knows about its lock status.

Method Summary

Modifier and Type	Method	Description
UserIdentity	getLockOwner()	Returns the owner of the lock, or null if none
boolean	isLocked()	Returns true if this AmetysObject is locked

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

Method Details

isLocked

boolean isLocked()
          throws AmetysRepositoryException

Returns true if this AmetysObject is locked

Returns:

true if this AmetysObject is locked

Throws:

AmetysRepositoryException - if a problem occurs

getLockOwner

UserIdentity getLockOwner()
                   throws AmetysRepositoryException

Returns the owner of the lock, or null if none

Returns:

the owner of the lock, or null if none

Throws:

AmetysRepositoryException - if a problem occurs