com.modeliosoft.modelio.cms.api.contrib

Interface IGetLockConfig

public interface IGetLockConfig

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.
void	addFiles(java.util.Collection<java.io.File> f) Add files to lock.
java.util.Collection<java.io.File>	getAdditionalFiles()
java.lang.String	getComment() Get the comment that will annotate the get lock operation.
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.
boolean	isBatchMode()
boolean	isRecursive() Get whether the get lock is recursive.
void	setComment(java.lang.String comment) Define the comment that will annotate the get lock operation.

Method Detail

setComment

void setComment(java.lang.String comment)

Define the comment that will annotate the get lock operation.

Parameters:

comment - a comment string.

addElements

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

Add elements to be locked.

Parameters:

el - The elements to be locked.

getComment

java.lang.String getComment()

Get the comment that will annotate the get lock operation.

Returns:

the lock comment.

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.

addElement

void addElement(MObject el)

Add elements to be locked.

Parameters:

el - An element to be locked.

isRecursive

boolean isRecursive()

Get whether the get lock is recursive.

Returns:

the true if recursive, else false.

isBatchMode

boolean isBatchMode()

Returns:

true for batch mode. False to show GUI.

addFiles

void addFiles(java.util.Collection<java.io.File> f)

Add files to lock.

Parameters:

f - the files to lock.

getAdditionalFiles

java.util.Collection<java.io.File> getAdditionalFiles()

Returns:

the additional files to lock