com.modeliosoft.modelio.cms.api.admin

Interface ICreateBranchCommand

public interface ICreateBranchCommand

Command that creates a branch for a whole project fragment.

The branch is based on the last revision of the repository pointed by the working copy.

Since:

3.5

Author:

cmarin

Method Summary

Modifier and Type	Method and Description
ICreateBranchCommand	addElement(MObject el) Add an element.
void	execute(org.modelio.vbasic.progress.IModelioProgress monitor) Run the operation.
ICreateBranchCommand	setBranchSpec(java.lang.String tagSpec) Set the tag specification.
ICreateBranchCommand	setCommitMessage(java.lang.String commitMessage) Set the comment that will be set as commit message for the tag creation.
ICreateBranchCommand	setFragment(IProjectFragment fragment) Set the fragment to create a tag for.

Method Detail

execute

void execute(org.modelio.vbasic.progress.IModelioProgress monitor)
      throws CmsException

Run the operation.

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.

Throws:

CmsException - on failure

setCommitMessage

ICreateBranchCommand setCommitMessage(java.lang.String commitMessage)

Set the comment that will be set as commit message for the tag creation.

Parameters:

commitMessage - the commit content.

Returns:

the same command to chain calls.

setFragment

ICreateBranchCommand setFragment(IProjectFragment fragment)

Set the fragment to create a tag for.

Parameters:

fragment - the CMS fragment.

Returns:

the same command to chain calls.

setBranchSpec

ICreateBranchCommand setBranchSpec(java.lang.String tagSpec)

Set the tag specification.

The specification depends on the repository technology. For SVN the specification is the complete URL of the tag to create.

Parameters:

tagSpec - the tag specification

Returns:

the same command to chain calls.

addElement

ICreateBranchCommand addElement(MObject el)

Add an element.

The element will be used to guess the fragment to tag.

Parameters:

el - a CMS managed element.

Returns:

the same command to chain calls.