com.axemble.vdoc.sdk.supports

Interface ILockSupport

All Superinterfaces:

IDeletionSupport, IElement, IProtocolSupport, IResource, ISearchSupport, ISecuritySupport, Serializable

All Known Subinterfaces:

IWorkflowInstance

public interface ILockSupport
extends IResource

Author:

bchapoton

Method Summary

Modifier and Type	Method and Description
boolean	isLockBySDK(IContext context) Is resource SDK by lock
boolean	isLockBySDK(IContext context, boolean cleanSessionLock) Is resource SDK by lock ( try to unlock resource before).
boolean	isLocked(IContext context) Is resource locked
boolean	isLocked(IContext context, boolean cleanSessionLock) Is resource locked ( try to unlock resource before ).
void	lock(IContext context, int delay) Lock a resource
Collection<IUser>	lockedBy(IContext context) Retrieve the users who locked the resource.
Collection<IUser>	lockedBy(IContext context, boolean cleanSessionLock) Retrieve the users who locked the resource ( try to unlock resource before).
void	unlock(IContext context) Unlock a resource

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IResource

addLinkedResource, addLinkedResources, allowEvents, createLinkedResource, deleteLinkedResource, deleteLinkedResources, denyEvents, exists, getCreatedBy, getCreatedDate, getDefinition, getHistory, getLinkedResources, getList, getModifiedBy, getModifiedDate, getName, getText, getValue, refresh, refresh, save, save, setCreatedBy, setCreatedDate, setList, setModifiedBy, setModifiedDate, setValue, setValueNoEvents

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Method Detail

lock

void lock(IContext context,
          int delay)

Lock a resource

Parameters:

context - The execution context.

delay - lock delay in second

unlock

void unlock(IContext context)

Unlock a resource

Parameters:

context - The execution context.

isLocked

boolean isLocked(IContext context)

Is resource locked

Parameters:

context - The execution context.

Returns:

true if the resource has been locked, false otherwise.

isLocked

boolean isLocked(IContext context,
                 boolean cleanSessionLock)

Is resource locked ( try to unlock resource before ).

Parameters:

context - The execution context.

cleanSessionLock - try to unlock resource before

Returns:

true if the resource has been locked, false otherwise.

lockedBy

Collection<IUser> lockedBy(IContext context)

Retrieve the users who locked the resource.

Parameters:

context - The execution context.

Returns:

a list of IUser users.

lockedBy

Collection<IUser> lockedBy(IContext context,
                           boolean cleanSessionLock)

Retrieve the users who locked the resource ( try to unlock resource before).

Parameters:

context - The execution context.

cleanSessionLock - try to unlock resource before

Returns:

a list of IUser users.

isLockBySDK

boolean isLockBySDK(IContext context)

Is resource SDK by lock

Parameters:

context - The execution context.

Returns:

true if the resource has been locked by SDK, false otherwise.

isLockBySDK

boolean isLockBySDK(IContext context,
                    boolean cleanSessionLock)

Is resource SDK by lock ( try to unlock resource before).

Parameters:

context - The execution context.

cleanSessionLock - try to unlock resource before

Returns:

true if the resource has been locked by SDK, false otherwise.