com.modeliosoft.modelio.cms.api

Interface IUpdateCommand

public interface IUpdateCommand

Update repository command interface.

This command updates a fragment against repository changes. The fragment is designated by adding CMS node model elements to the getElements() list.

Method Summary

Modifier and Type	Method and Description
void	add(java.util.Collection<MObject> cmsNodes) Deprecated. use add(Collection) instead.
void	addElement(MObject element) Add CMS node element to be updated.
void	addElements(java.util.Collection<MObject> elements) Add CMS node elements to be updated.
IUpdateDetails	execute(org.modelio.vbasic.progress.IModelioProgress iMonitor) Update the project against repository changes and passed parameters.
IUpdateConfig	getConfiguration()
java.util.Collection<MObject>	getElements() Get the elements where the update command is run.
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.
IUpdateDetails	switchRepository(org.modelio.vbasic.progress.IModelioProgress iMonitor, IProjectFragment fragment, java.lang.String newPath) Switch the working copy to another repository URL.
boolean	useProcessExtension() Tells whether the the process model extensions will be called.

Method Detail

switchRepository

IUpdateDetails switchRepository(org.modelio.vbasic.progress.IModelioProgress iMonitor,
                                IProjectFragment fragment,
                                java.lang.String newPath)
                         throws CmsException

Switch the working copy to another repository URL.

Imports in the model the differences between the old and new repository.

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.

fragment - the fragment to switch

newPath - the new branch URL

Returns:

The result of the import of changed elements.

Throws:

CmsException - in case of failure. The connection is not usable.

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.

Since:

3.5

execute

IUpdateDetails execute(org.modelio.vbasic.progress.IModelioProgress iMonitor)
                throws java.io.IOException,
                       CmsException,
                       TransactionStillOpenException

Update the project against repository changes and passed 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 update result.

Throws:

java.io.IOException - dependency analysis failed

CmsException - updating working copy failed

TransactionStillOpenException - if a Modelio transaction is currently open

add

@Deprecated
void add(java.util.Collection<MObject> cmsNodes)

Deprecated. use add(Collection) instead.

Add CMS node elements to be updated.

As the update command updates whole model fragments, adding an element will make the whole element fragment update.

Parameters:

cmsNodes - the CMS node elements to update.

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

getElements

java.util.Collection<MObject> getElements()

Get the elements where the update command is run.

As the update command updates whole model fragments, adding an element will make the whole element fragment update.

Returns:

the elements to update.

getConfiguration

IUpdateConfig getConfiguration()

Returns:

the command configuration for process extensions.

Since:

3.5

addElement

void addElement(MObject element)

Add CMS node element to be updated.

As the update command updates whole model fragments, adding an element will make the whole element fragment update.

Parameters:

element - the elements to update.

Since:

3.7.1

addElements

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

Add CMS node elements to be updated.

As the update command updates whole model fragments, adding an element will make the whole element fragment update.

Parameters:

elements - the elements to update.

Since:

3.7.1