com.modeliosoft.modelio.cms.api

Interface IRevertResult

public interface IRevertResult

Result of a successful update operation in the working copy.

Method Summary

Modifier and Type	Method and Description
void	addErrorOn(MRef ref, java.lang.String error) Add an error encountered on an element.
IBlobChangeEvent	getBlobChanges() Deprecated.
java.util.List<MObject>	getCreatedElements() Deprecated.
java.util.List<MRef>	getDeletedElements() Deprecated.
java.util.Map<MRef,java.lang.String>	getElementErrors() Get errors encountered on revert.
CmsException	getFatalError() Get the fatal error that interrupted the operation.
java.util.Collection<IRevertFragmentResult>	getFragments()
java.util.List<MObject>	getModifiedElements() Deprecated.
java.util.Collection<IElementMoveRef>	getMoveReferences() Get the element moves made by the revert operation.
java.util.Set<IElementMove>	getMoves() Get the element moves made by the revert operation.
ISymbolService	getSymbolService() Get the symbol service.
boolean	isBatchMode() A command run in batch mode did not trigger any UI.

Method Detail

getModifiedElements

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

Deprecated.

Get the CMS nodes updated in the working copy.

Returns:

the updated CMS nodes.

getCreatedElements

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

Deprecated.

Get the created CMS nodes.

Returns:

the created CMS nodes.

getDeletedElements

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

Deprecated.

Get the CMS nodes deleted from the working copy.

Returns:

the deleted CMS node references.

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

addErrorOn

void addErrorOn(MRef ref,
                java.lang.String error)

Add an error encountered on an element.

Parameters:

ref - the element on which the error occurred

error - the error message

getElementErrors

java.util.Map<MRef,java.lang.String> getElementErrors()

Get errors encountered on revert.

Returns:

the errors.

getMoves

java.util.Set<IElementMove> getMoves()

Get the element moves made by the revert operation.

Returns:

the element moves.

getFatalError

CmsException getFatalError()

Get the fatal error that interrupted the operation.

Returns null if the operation completed normally.

Returns:

the fatal error or null.

getBlobChanges

@Deprecated
IBlobChangeEvent getBlobChanges()

Deprecated.

Get the blobs changes made by the revert operation.

Blobs created by the revert are blobs that have been undeleted.

Returns:

the blob changes.

isBatchMode

boolean isBatchMode()

A command run in batch mode did not trigger any UI.

Returns:

whether the command was run in batch mode.

getMoveReferences

java.util.Collection<IElementMoveRef> getMoveReferences()

Get the element moves made by the revert operation.

Returns:

the element moves.

getFragments

java.util.Collection<IRevertFragmentResult> getFragments()

Returns:

the revert result for each fragment.