com.modeliosoft.modelio.cms.api

Interface IAddCommand

public interface IAddCommand

Mark the elements to be added to version control.

Take the SVN lock on the necessary parent elements before marking the elements. If some parents cannot be locked, only the elements whose parent is writable will be added to version.

Method Summary

Modifier and Type	Method and Description
void	addElement(MObject toAdd) Add the given element to the collection of elements to add.
void	addElements(java.util.Collection<MObject> toAdd) Add the given elements to the collection of elements to add.
void	addFiles(java.util.Collection<java.io.File> f, java.util.Map<java.lang.String,java.lang.String> cmsProps) Add files to be added to version with SVN properties.
IAddResult	execute(org.modelio.vbasic.progress.IModelioProgress iMonitor) Mark the elements to be added to version control.
IAddConfig	getConfiguration()
java.util.Collection<MObject>	getElements() Get the elements to add.
boolean	isBatchMode()
void	setBatch(boolean batchMode) Set whether the command must be run in batch mode
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

IAddResult execute(org.modelio.vbasic.progress.IModelioProgress iMonitor)
            throws CmsException,
                   java.lang.IllegalStateException

Mark the elements to be added to version control.

Take the SVN lock on the necessary parent elements before marking the elements. If some parents cannot be locked, only the elements whose parent is writable will be added to version.

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 cancelled.

Returns:

The result of the get lock operation that may have been necessary to run on the parent element(s). Return null if no get lock operation was necessary.

Throws:

CmsException - if the operation fails.

java.lang.IllegalStateException - if there is no repository connection.

addElements

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

Add the given elements to the collection of elements to add.

Parameters:

toAdd - the elements to add.

addElement

void addElement(MObject toAdd)

Add the given element to the collection of elements to add.

Parameters:

toAdd - the element to add.

Since:

3.7.1

getElements

java.util.Collection<MObject> getElements()

Get the elements to add.

The returned collection reflects the command configuration and may be freely modified .

Returns:

element a reference to the list of elements to add.

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.

useProcessExtension

boolean useProcessExtension()

Tells whether the the process model extensions will be called.

Returns:

true to use the process model extensions will be called.

getConfiguration

IAddConfig getConfiguration()

Returns:

the command configuration.

Since:

3.5

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.

addFiles

void addFiles(java.util.Collection<java.io.File> f,
              java.util.Map<java.lang.String,java.lang.String> cmsProps)

Add files to be added to version with SVN properties.

Parameters:

f - the files to add

cmsProps - SVN properties to put on the files. null to apply default properties.

Since:

3.5