com.modeliosoft.modelio.cms.api.contrib

Interface ICommitConfig

public interface ICommitConfig

Method Summary

Modifier and Type	Method and Description
void	addElements(java.util.Collection<MObject> elementsToAdd, org.modelio.vbasic.progress.IModelioProgress monitor) Add elements to be committed.
void	addFilesToAdd(java.util.Collection<java.io.File> f) Add files to add to version.
void	addFilesToAdd(java.util.Collection<java.io.File> f, java.util.Map<java.lang.String,java.lang.String> cmsProps) Add files to add to version.
void	addFileToModify(java.io.File f) Add a file to commit.
void	addFileToRemove(java.io.File toRemove) Add a file to remove from version.
ICommitDetail	getCommitAnalysis() Get the list of elements to commit after dependency analysis.
java.util.Collection<MObject>	getElements() Get the elements to commit.
java.util.Collection<java.io.File>	getFilesToCommit() Get the addictional files to commit.
boolean	getKeepLocks() Tells whether locks must be kept or released.
java.lang.String	getMessage() Get the commit comment
boolean	isBatchMode()
boolean	isRecursive() Get whether the commit must be recursive.
void	setKeepLocks(boolean keepLocks) Set whether locks must be kept or released.
void	setMessage(java.lang.String comment) Set the commit comment.
void	setRecursive(boolean isRecursive, org.modelio.vbasic.progress.IModelioProgress monitor) Set whether the commit must be recursive.

Method Detail

addElements

void addElements(java.util.Collection<MObject> elementsToAdd,
                 org.modelio.vbasic.progress.IModelioProgress monitor)
          throws InvalidCmsStateException,
                 ReverseFailedException

Add elements to be committed.

Calling this method reruns dependency analysis and invalidates the ICommitDetail returned by getCommitAnalysis() . getCommitDetails() must then be called again to get the new commit details.

Parameters:

elementsToAdd - The elements to be added to the commit operation.

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

Throws:

ReverseFailedException - if the code reverse fails on an element.

InvalidCmsStateException - if the model CMS state is not consistent

addFileToModify

void addFileToModify(java.io.File f)

Add a file to commit.

The file will be added to version if not already done.

Parameters:

f - The file to commit.

addFileToRemove

void addFileToRemove(java.io.File toRemove)

Add a file to remove from version.

Parameters:

toRemove - the file to remove.

addFilesToAdd

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

Add files to add to version.

Parameters:

f - the files to add

addFilesToAdd

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

Add files to add to version.

Parameters:

f - the files to add

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

getCommitAnalysis

ICommitDetail getCommitAnalysis()

Get the list of elements to commit after dependency analysis.

Returns:

the elements to commit

getElements

java.util.Collection<MObject> getElements()

Get the elements to commit.

Returns:

the list of elements to commit.

getFilesToCommit

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

Get the addictional files to commit.

The returned collection excludes EXML files, it only includes files added by addFile() and deleteFile() .

Returns:

the initial list of elements to commit.

getKeepLocks

boolean getKeepLocks()

Tells whether locks must be kept or released.

Returns:

true to keep the locks, false to release them.

getMessage

java.lang.String getMessage()

Get the commit comment

Returns:

the comment

isBatchMode

boolean isBatchMode()

Returns:

true for batch mode. False to show GUI.

isRecursive

boolean isRecursive()

Get whether the commit must be recursive.

Returns:

whether the commit must be recursive.

setKeepLocks

void setKeepLocks(boolean keepLocks)

Set whether locks must be kept or released.

Parameters:

keepLocks - true to keep the locks, false to release them.

setMessage

void setMessage(java.lang.String comment)

Set the commit comment.

Parameters:

comment - the comment to set

setRecursive

void setRecursive(boolean isRecursive,
                  org.modelio.vbasic.progress.IModelioProgress monitor)
           throws InvalidCmsStateException,
                  ReverseFailedException

Set whether the commit must be recursive.

Changing this value reruns dependency analysis and invalidates the ICommitDetail returned by getCommitAnalysis() . getCommitDetails() must then be called again to get the new commit details.

Parameters:

isRecursive - whether the commit must be recursive.

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

Throws:

ReverseFailedException - if the code reverse fails on an element.

InvalidCmsStateException - if the model CMS state is not consistent