com.modeliosoft.modelio.cms.api

Interface IGetLockCommand

public interface IGetLockCommand

Get SVN lock command interface.

Method Summary

Modifier and Type	Method and Description
void	addElement(MObject el) Add elements to be locked.
void	addElements(java.util.Collection<MObject> el) Add elements to be locked.
IGetLockResult	execute(org.modelio.vbasic.progress.IModelioProgress iMonitor) Get the lock on elements specified by the given parameters.
java.lang.String	getComment() Get the comment that will annotate the get lock operation.
IGetLockConfig	getConfiguration()
java.util.Set<MObject>	getElements() Get the elements on which the command will be run.
boolean	isBatchMode()
boolean	isRecursive() Get whether the get lock is recursive.
void	setBatch(boolean batchMode) Set whether the command must be run in batch mode
void	setComment(java.lang.String comment) Define the comment that will annotate the get lock operation.
boolean	setRecursive(boolean isRecursive) Set whether the get lock is recursive .
void	setStealLocks(boolean stealLocks) Set whether the lock should be stolen if already owned by someone else.
void	setUseProcessExtension(boolean val) Set whether the the process model extensions will be called.
boolean	useProcessExtension() Tells whether the the process model extensions will be called.

Method Detail

execute

IGetLockResult execute(org.modelio.vbasic.progress.IModelioProgress iMonitor)
                throws CmsException

Get the lock on elements specified by the given parameters.

Parameters:

iMonitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor. Accepts null, indicating that no progress should be reported and that the operation cannot be canceled.

Returns:

The result of the get lock

Throws:

CmsException - in case of other failure

setStealLocks

void setStealLocks(boolean stealLocks)

Set whether the lock should be stolen if already owned by someone else.

Parameters:

stealLocks - true to steal locks

setComment

void setComment(java.lang.String comment)

Define the comment that will annotate the get lock operation.

Parameters:

comment - a comment string.

setRecursive

boolean setRecursive(boolean isRecursive)

Set whether the get lock is recursive .

Parameters:

isRecursive - whether the get lock should be recursive

Returns:

true if the value changed, false in the other case.

isRecursive

boolean isRecursive()

Get whether the get lock is recursive.

Returns:

the true if recursive, else false.

getElements

java.util.Set<MObject> getElements()

Get the elements on which the command will be run.
The set of elements does not have to contain descendant elements when isRecursive() is set.

Returns:

Elements on which the Get lock will be run.

addElements

void addElements(java.util.Collection<MObject> el)

Add elements to be locked.

Parameters:

el - The elements to be locked.

addElement

void addElement(MObject el)

Add elements to be locked.

Parameters:

el - An element to be locked.

getComment

java.lang.String getComment()

Get the comment that will annotate the get lock operation.

Returns:

the lock comment.

setBatch

void setBatch(boolean batchMode)

Set whether the command must be run in batch mode

Parameters:

batchMode - true for batch mode. false to allow GUI.

isBatchMode

boolean isBatchMode()

Returns:

true for batch mode. False to show GUI.

Since:

3.5

setUseProcessExtension

void setUseProcessExtension(boolean val)

Set whether the the process model extensions will be called.

Parameters:

val - true to use the process model extensions will be called.

Since:

3.5

useProcessExtension

boolean useProcessExtension()

Tells whether the the process model extensions will be called.

Returns:

true to use the process model extensions will be called.

Since:

3.5

getConfiguration

IGetLockConfig getConfiguration()

Returns:

the command configuration

Since:

3.5