Lock Aspect

Document created by resplin Employee on Jun 6, 2015
Version 1Show Document
  • View in full screen mode

Obsolete Pages{{Obsolete}}

The official documentation is at: http://docs.alfresco.com



Back to Main Page > Specification


Attributes


  • lock_owner - a reference to the owner of the lock.  A value of null indicates that no lock is present.
  • lock_expires - when the lock expires. A value of 0 indicates that the lock never expires.
  • lock_date - when the lock was taken out.

API


lock


void lock(wsid, uuid, owner);

Description:

Locks a given object in a workspace for a given lock owner.

Parameters:


  • wsid - the workspace id
  • uuid - the id of the object to lock
  • owner - the owner of the lock

Result:

void

Exception cases:


  • The object cannot be locked.
  • You don't have permission to lock the object.



void lock(wsid, uuid_list, owner);

Description:

Locks a given list of objects in a workspace for a given lock owner.

Parameters:


  • wsid - the workspace id
  • uuid_list - the ids of the objects to lock
  • owner - the owner of the lock

Result:

void

Exception cases:


  • One of the objects can not be locked
  • You don't have permission to lock the objects






release


void release(wsid, uuid);

Description:

Releases the lock held on a given object in a workspace.

Parameters:


  • wsid - the workspace id
  • uuid - the id of the object

Result:

void

Exception cases:


  • The lock cannot be released.
  • You don't have permission to release the lock.



void release(wsid, uuid_list);

Description:

Releases the locks held on given objects in a workspace.

Parameters:


  • wsid - the workspace id
  • uuid_list - the ids of the objects

Result:

void

Exception cases:


  • One of the locks can not be released.
  • You don't have permission to release one of the locks.






isLocked


boolean isLocked(wsid, uuid);

Description:

Indicates whether the specified object is locked within the workspace.

Parameters:


  • wsid - the workspace id
  • uuid - the id of the object

Result:


  • true if the object is locked, false otherwise

Exception cases:


  • None


Aspects

Attachments

    Outcomes