com.modeliosoft.modelio.cms.api

Interface ICommitResultFragment

public interface ICommitResultFragment

Final result of a commit operation.

This interface gives access to:

• the elements that were added, modified or removed from the repository.
  
• isEmpty() : can be used to test if anything was committed.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<MObject>	getAddedElements() Get the list of CMS elements added to version control.
java.lang.String	getCommitAuthor() Get the author of the commit.
java.util.Date	getCommitDate() Get the commit date.
java.lang.String	getCommittedRevision() Get the committed revision.
java.util.Collection<MRef>	getDeletedElements() Get the list of references of elements removed from version.
java.util.Collection<ICommitEntry>	getEntries() Get all model object modifications at a whole.
IGetLockResult	getLockResult() Get the result of "Get lock" on added elements.
java.lang.String	getMessage() Get the commit message filled by the user.
java.util.Collection<MObject>	getModifiedElements() Get the list of modified CMS nodes.
java.util.Collection<java.io.File>	getOtherAddedFiles() Get the non model files added to the repository.
java.util.Collection<java.io.File>	getOtherDeletedFiles() Get the non model files deleted from repository.
java.util.Collection<java.io.File>	getOtherModifiedFiles() Get the non model files modified in repository.
IProjectFragment	getProjectFragment()
ICmsUnlockResult	getUnlockResult() Get the result of the "unlock" operation that may be done optionally.
boolean	isEmpty() Returns true if there is nothing to commit.

Method Detail

getModifiedElements

java.util.Collection<MObject> getModifiedElements()

Get the list of modified CMS nodes.

Returns:

the already versioned committed elements.

getAddedElements

java.util.Collection<MObject> getAddedElements()

Get the list of CMS elements added to version control.

Returns:

the new CMS nodes

getDeletedElements

java.util.Collection<MRef> getDeletedElements()

Get the list of references of elements removed from version.

Returns:

the deleted element references.

getMessage

java.lang.String getMessage()

Get the commit message filled by the user.

Returns:

The commit message. May return null if nothing was committed.

isEmpty

boolean isEmpty()

Returns true if there is nothing to commit.

Returns:

true if there is nothing to commit.

getCommittedRevision

java.lang.String getCommittedRevision()

Get the committed revision.

Returns:

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

getCommitDate

java.util.Date getCommitDate()

Get the commit date.

Returns:

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

getCommitAuthor

java.lang.String getCommitAuthor()

Get the author of the commit.

Returns:

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

getEntries

java.util.Collection<ICommitEntry> getEntries()

Get all model object modifications at a whole.

Contains all additions, modifications and deletions.

Returns:

the whole commit content.

getProjectFragment

IProjectFragment getProjectFragment()

Returns:

the model fragment where commit was called.

getLockResult

IGetLockResult getLockResult()

Get the result of "Get lock" on added elements.

Returns something only when elements were added to version and "keep locks" was asked.

Returns:

the result of "Get lock" on added elements.

getUnlockResult

ICmsUnlockResult getUnlockResult()

Get the result of the "unlock" operation that may be done optionally.

Returns something only when "unlock" was run. Returns null if no such unlock was run.

Returns:

the unlock result or null.

getOtherAddedFiles

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

Get the non model files added to the repository.

Returns:

the added non model files.

getOtherModifiedFiles

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

Get the non model files modified in repository.

Returns:

the modified non model files.

getOtherDeletedFiles

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

Get the non model files deleted from repository.

Returns:

the deleted non model files.