de.innovationgate.webgate.api.locking

Interface Lockable

All Known Implementing Classes:

WGArea, WGContent, WGContentType, WGCSSJSModule, WGDatabase, WGDesignDocument, WGDesignResourceDocument, WGDocument, WGFileContainer, WGLanguage, WGSchemaDocument, WGScriptModule, WGStructEntry, WGTMLModule, WGUserProfile

public interface Lockable

interface for all lockable wgapi-objects

Method Summary

Methods

Modifier and Type	Method and Description
int	getLockStatus(LockOwner caller) returns the current lockstatus of the lockable - if parent is set and locked the lockstatus is inherited
Lockable	getParentLockable() returns the parent lockable of this lockable for e.g.
void	lock(LockOwner owner) locks the object for the given owner
void	unlock(LockOwner owner) unlock the object if it is locked by the given owner this method only delegates to LockOwner.releaseLock()

Method Detail

lock

void lock(LockOwner owner)
          throws WGAPIException

locks the object for the given owner

Throws:

WGAPIException - - instance of LockWaitTimeoutException when the lock request timed out

See Also:

- instance of ParentIsLockedException when the lock cannot be obtained because the parent object is already locked - other API Exceptions on API errors

unlock

void unlock(LockOwner owner)

unlock the object if it is locked by the given owner this method only delegates to LockOwner.releaseLock()

Parameters:

owner - - the LockOwner who has obtained the lock

getLockStatus

int getLockStatus(LockOwner caller)
                  throws WGAPIException

returns the current lockstatus of the lockable - if parent is set and locked the lockstatus is inherited

Parameters:

caller - - LockOwner who wants to retrieve his lockstatus for this document

Returns:

NOT_LOCKED, LOCKED_BY_FOREIGN_OBJECT or LOCKED_BY_THIS_OBJECT

Throws:

WGAPIException

getParentLockable

Lockable getParentLockable()
                           throws WGAPIException

returns the parent lockable of this lockable for e.g. WGStructEntry in case of WGContent

Throws:

WGAPIException