com.modeliosoft.modelio.cms.api

Interface ICommitCommand

public interface ICommitCommand

Commit the given elements in subversion and by default put the CMS lock on them so that they cannot be modified again.

A Process Extension Module can parameterize the commit command.

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.
boolean	callPemPreCommit(org.modelio.vbasic.progress.IModelioProgress monitor) Calls IProcessExtension.preCommit(IModelioProgress, ICommitCommand) on the Process Extension Model (PEM) and unloads the model change keeper in case failure or exception.
ICommitResult	execute(org.modelio.vbasic.progress.IModelioProgress iMonitor) Execute the commit the elements in subversion and put the CMS lock on them so that they cannot be modified again.
ICommitDetail	getCommitAnalysis() Get the list of elements to commit after dependency analysis.
ICommitConfig	getConfiguration()
boolean	getKeepLocks() Tells whether locks must be kept or released.
java.lang.String	getMessage() Get the commit comment
java.util.Collection<MObject>	getSelection() Get the elements on which the commit was initially run.
boolean	isBatchMode()
boolean	isRecursive() Get whether the commit must be recursive.
void	setBatch(boolean batchMode) Set whether the command must be run in batch mode.
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.
void	setUseProcessExtension(boolean val) Set whether the the process model extension (PEM) will be called.
boolean	useProcessExtension() Tells whether the the process model extensions will be called.

Method Detail

addElements

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

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

addFilesToAdd

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

Add files to add to version.

Parameters:

f - the files to add

Since:

3.5

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.

Since:

3.5

callPemPreCommit

boolean callPemPreCommit(org.modelio.vbasic.progress.IModelioProgress monitor)

Calls IProcessExtension.preCommit(IModelioProgress, ICommitCommand) on the Process Extension Model (PEM) and unloads the model change keeper in case failure or exception.

Please call this method instead of accessing directly the PEM to maintain the model consistency.

Parameters:

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.

Returns:

true if the commit is confirmed, false to cancel the commit operation.

Since:

3.5

execute

ICommitResult execute(org.modelio.vbasic.progress.IModelioProgress iMonitor)
               throws CmsException,
                      OutdatedElementsException

Execute the commit the elements in subversion and put the CMS lock on them so that they cannot be modified again.

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 commit result or null if nothing was committed.

Throws:

CmsException - if the commit failed.

OutdatedElementsException - if some of the elements to commit are out of date.

getCommitAnalysis

ICommitDetail getCommitAnalysis()

Get the list of elements to commit after dependency analysis. The returned set cannot be modified.

Returns:

the elements to commit

getConfiguration

ICommitConfig getConfiguration()

Returns:

the command configuration.

Since:

3.5

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

getSelection

java.util.Collection<MObject> getSelection()

Get the elements on which the commit was initially run.

addElements(...) has no effect on this method.

Returns:

the initial list of elements to commit.

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.

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.

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 ReverseFailedException,
                  InvalidCmsStateException

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

setUseProcessExtension

void setUseProcessExtension(boolean val)

Set whether the the process model extension (PEM) will be called.

If disabling the PEM to handle it manually, call callPemPreCommit(IModelioProgress) instead of IProcessExtension.preCommit(IModelioProgress, ICommitCommand) to maintain the model consistency on failures.

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