com.modeliosoft.modelio.cms.api.contrib

Interface IUpdateConfig

public interface IUpdateConfig

Configuration of the update command.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalFile(java.io.File toUpdate) Add a file/directory to update recursively.
void	addFragment(IGModelFragment f) Add a project fragment to update.
java.util.Collection<java.io.File>	getAdditionalFiles() Get the additional files/directories to update.
java.util.Collection<MObject>	getElements() Get the list of elements where the update command is run.
java.util.Collection<IGModelFragment>	getFragments() Get the list of project fragments where the update command is run.
java.lang.String	getRevision()
boolean	isBatchMode()
void	setRevision(java.lang.String revision) Set the revision to which the update must be done.

Method Detail

addAdditionalFile

void addAdditionalFile(java.io.File toUpdate)

Add a file/directory to update recursively.

Parameters:

toUpdate - a file/directory to update recursively.

addFragment

void addFragment(IGModelFragment f)
          throws java.lang.IllegalArgumentException

Add a project fragment to update.

Parameters:

f - a project fragment to update.

Throws:

java.lang.IllegalArgumentException - if the fragment is not versioned.

Since:

3.6

getAdditionalFiles

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

Get the additional files/directories to update.

These directories will be updated at the same time as the model working copy.

Returns:

the initial list of elements to commit.

getElements

java.util.Collection<MObject> getElements()

Get the list of elements where the update command is run.

As the update command always update the whole fragment, this collection contains the root elements of the model fragment to update.

Returns:

the elements to update.

getFragments

java.util.Collection<IGModelFragment> getFragments()

Get the list of project fragments where the update command is run.

As the update command always update the whole fragment, this collection contains model fragment to update.

This collection is not modifiable.

Returns:

the model fragments to update.

Since:

3.6

See Also:

#addFragment(IProjectFragment)

getRevision

java.lang.String getRevision()

Returns:

the revision to which the update must be done.

isBatchMode

boolean isBatchMode()

Returns:

true for batch mode. False to show GUI.

setRevision

void setRevision(java.lang.String revision)

Set the revision to which the update must be done.

null is the default value, that means update to the last revision.

Parameters:

revision - the revision to update to.