com.modeliosoft.modelio.cms.api

Interface ICommitResult

public interface ICommitResult

Final result of a commit operation.

The commit is decomposed of fragments: one for each project fragment involved in the commit operation.

This interface gives access to:

• getFragments(): describe the elements that were added, modified or removed from the repository for each project fragment involved in the commit operation.
• getSymbolService() : provides a symbol services that gives the name or the absolute name of any committed element.
  
• isEmpty() : can be used to test if anything was committed.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<MObject>	getAddedElements() Deprecated. call the same method for each fragment returned by getFragments()
java.lang.String	getCommitAuthor() Deprecated. call the same method for each fragment returned by getFragments()
java.util.Date	getCommitDate() Deprecated. call the same method for each fragment returned by getFragments()
java.lang.String	getCommittedRevision() Deprecated. call the same method for each fragment returned by getFragments()
java.util.Collection<MRef>	getDeletedElements() Deprecated. call the same method for each fragment returned by getFragments()
java.util.Collection<? extends ICommitResultFragment>	getFragments() Get the list of modified CMS nodes.
java.util.Collection<MObject>	getModifiedElements() Deprecated. call the same method for each fragment returned by getFragments()
java.util.Collection<IElementMove>	getMoves() Get the list of element moves that have been committed.
java.util.Map<MObject,MObject>	getNeededNonVersionedElements() Deprecated. call the same method for each fragment returned by getFragments()
ISymbolService	getSymbolService() Get the symbol service.
boolean	isBatchMode()
boolean	isEmpty() Returns true if there is nothing to commit.

Method Detail

getFragments

java.util.Collection<? extends ICommitResultFragment> getFragments()

Get the list of modified CMS nodes.

Returns:

the already versioned committed elements.

getMoves

java.util.Collection<IElementMove> getMoves()

Get the list of element moves that have been committed.

Note: The involved elements also belong to the modified or created elements list.

Returns:

The committed moves.

getSymbolService

ISymbolService getSymbolService()

Get the symbol service. This service is able to give the name of a CMS node even if the given element does not exist in the model anymore, as long as it is present in the repository.

Returns:

the symbol service.

isEmpty

boolean isEmpty()

Returns true if there is nothing to commit.

Returns:

true if there is nothing to commit.

getDeletedElements

@Deprecated
java.util.Collection<MRef> getDeletedElements()

Deprecated. call the same method for each fragment returned by getFragments()

Get the list of references of elements removed from version.

Returns:

the deleted element references.

getModifiedElements

@Deprecated
java.util.Collection<MObject> getModifiedElements()

Deprecated. call the same method for each fragment returned by getFragments()

Get the list of modified CMS nodes.

Returns:

the already versioned committed elements.

getCommitAuthor

@Deprecated
java.lang.String getCommitAuthor()

Deprecated. call the same method for each fragment returned by getFragments()

Get the author of the commit.

Returns:

the commit author. May return null if nothing was committed.

getCommittedRevision

@Deprecated
java.lang.String getCommittedRevision()

Deprecated. call the same method for each fragment returned by getFragments()

Get the committed revision.

Returns:

the committed revision. May return null if nothing was committed.

getNeededNonVersionedElements

@Deprecated
java.util.Map<MObject,MObject> getNeededNonVersionedElements()

Deprecated. call the same method for each fragment returned by getFragments()

Get needed elements that are not versioned. These dependencies prevent any commit until they are added to version.

Returns:

a map with the needed element as key and a needing element as value.

getCommitDate

@Deprecated
java.util.Date getCommitDate()

Deprecated. call the same method for each fragment returned by getFragments()

Get the commit date.

Returns:

the date where the commit was validated. May return null if nothing was committed.

getAddedElements

@Deprecated
java.util.Collection<MObject> getAddedElements()

Deprecated. call the same method for each fragment returned by getFragments()

Get the list of CMS elements added to version control.

Returns:

the new CMS nodes

isBatchMode

boolean isBatchMode()