com.modeliosoft.modelio.cms.api

Interface ICommitDetail

public interface ICommitDetail

Detail of a commit operation to be done.

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

Method Summary

Modifier and Type	Method and Description
java.util.Map<MObject,MObject>	getConflictedElements() Deprecated. Call the same method on each fragment returned by getFragments().
java.util.Collection<MObject>	getCreatedElements() Deprecated. Call the same method on each fragment returned by getFragments().
java.util.Collection<java.lang.String>	getDeletedBlobs() Deprecated. Call the same method on each fragment returned by getFragments().
java.util.Collection<MRef>	getDeletedElements() Deprecated. Call the same method on each fragment returned by getFragments().
java.util.Collection<? extends ICommitDetailFragment>	getFragments() Get the commit detail for each involved fragment.
java.lang.String	getMessage() Get the commit message filled by the user.
java.util.Collection<MObject>	getModifiedElements() Deprecated. Call the same method on each fragment returned by getFragments().
java.util.Collection<IElementMoveRef>	getMoveReferences() Get the list of element moves that will been committed.
java.util.Collection<IElementMove>	getMoves() Get the list of element moves that will been committed.
java.util.Map<MObject,MObject>	getNeededNonVersionedElements() Deprecated. Call the same method on each fragment returned by getFragments().
java.util.Collection<MObject>	getNonModifiedElementsToUnlock() Deprecated. Call the same method on each fragment returned by getFragments().
ISymbolService	getSymbolService() Get the symbol service.
boolean	hasConflictedElements()
boolean	hasNeededNonVersionedElements()
boolean	isEmpty() Returns true if there is nothing to commit.

Method Detail

getModifiedElements

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

Deprecated. Call the same method on each fragment returned by getFragments().

Get the list of modified CMS nodes.

Returns:

the already versioned committed elements

getCreatedElements

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

Deprecated. Call the same method on each fragment returned by getFragments().

Get the list of CMS elements to add to version control.

Returns:

the new CMS nodes

getDeletedElements

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

Deprecated. Call the same method on each fragment returned by getFragments().

Get the list of references of elements to remove from version.

Returns:

the element references to remove from version.

getConflictedElements

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

Deprecated. Call the same method on each fragment returned by getFragments().

Get the elements that prevent commit because they are in conflict.

These dependencies prevent any commit until they are resolved.

Returns:

the conflicted elements.

getNeededNonVersionedElements

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

Deprecated. Call the same method on 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

getNonModifiedElementsToUnlock

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

Deprecated. Call the same method on each fragment returned by getFragments().

Get the non modified elements whose lock should be released.

Returns:

non modified elements to unlock.

getMoves

java.util.Collection<IElementMove> getMoves()

Get the list of element moves that will been committed.

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

Returns:

The recorded 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

getMessage

java.lang.String getMessage()

Get the commit message filled by the user.

Returns:

The commit message.

getDeletedBlobs

@Deprecated
java.util.Collection<java.lang.String> getDeletedBlobs()

Deprecated. Call the same method on each fragment returned by getFragments().

Returns:

the deleted blobs keys

isEmpty

boolean isEmpty()

Returns true if there is nothing to commit.

Returns:

true if there is nothing to commit.

getFragments

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

Get the commit detail for each involved fragment.

Returns:

the fragments commit details.

hasNeededNonVersionedElements

boolean hasNeededNonVersionedElements()

Returns:

true if non versioned elements are to be added first.

hasConflictedElements

boolean hasConflictedElements()

Returns:

true if some of the elements to commit are conflicted.

getMoveReferences

java.util.Collection<IElementMoveRef> getMoveReferences()

Get the list of element moves that will been committed.

Notes:

• The involved elements also belong to the modified or created elements list.
• This method is same as getMoves() but also include moves involving deleted elements.

Returns:

The recorded moves.