com.modeliosoft.modelio.cms.api

Interface IGetLockResult

public interface IGetLockResult

Result of a completed "Get lock" command.

Tells :

• which elements could be locked,
• which ones couldn't and why they couldn't.
• the result of the update that was run before getting locks.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.io.File>	getAdditionalLockedFiles()
java.util.Map<java.io.File,java.lang.String>	getAdditionalLockFailures() Get the other lock failures.
java.util.Collection<java.io.File>	getAdditionalOutdatedFiles() Get the additional files that couldn't be locked because they are out of date.
java.util.Collection<MObject>	getLockedElements() Get the elements successfully locked.
java.util.Map<MRef,java.lang.String>	getLockedUnresolvedReferences() Get the references successfully locked that couldn't be resolved.
java.util.Map<MObject,java.lang.String>	getLockFailures() Get the other lock failures.
java.util.Collection<MObject>	getOutdatedElements() Get the elements that couldn't be locked because they are out of date.
java.util.Collection<MRef>	getOutdatedUnresolvedReferences() Get the unresolved references of elements that couldn't be locked because they are out of date.
ISymbolService	getSymbolService()
java.util.Map<MRef,java.lang.String>	getUnresolvedLockFailures() Get unresolved element references that couldn't be locked.
boolean	hasFailures() Quick method to know if something went wrong.
boolean	isBatchMode()

Method Detail

getLockedElements

java.util.Collection<MObject> getLockedElements()

Get the elements successfully locked.

Returns:

the reference of the elements successfully locked.

getLockedUnresolvedReferences

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

Get the references successfully locked that couldn't be resolved.

Such case can occur because:

• The element has not been imported (it is a bug)
• The metaclass does not exist anymore. The repository needs migration.

Returns:

the locked unresolved references with the resolution failure reason.

getLockFailures

java.util.Map<MObject,java.lang.String> getLockFailures()

Get the other lock failures.

These are lock failure that have other causes than already locked or out of date elements.

Returns:

a map with as key the reference that couldn't be locked, and the reason as value.

getUnresolvedLockFailures

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

Get unresolved element references that couldn't be locked.

Returns:

the not locked element references with the failure cause.

getSymbolService

ISymbolService getSymbolService()

Returns:

the symbol service.

getOutdatedElements

java.util.Collection<MObject> getOutdatedElements()

Get the elements that couldn't be locked because they are out of date.

Returns:

the out-dated elements.

getOutdatedUnresolvedReferences

java.util.Collection<MRef> getOutdatedUnresolvedReferences()

Get the unresolved references of elements that couldn't be locked because they are out of date.

Returns:

the out-dated elements.

hasFailures

boolean hasFailures()

Quick method to know if something went wrong.

Returns:

true if some elements couldn't be locked.

isBatchMode

boolean isBatchMode()

Returns:

true if the command was run in batch mode.

getAdditionalLockedFiles

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

getAdditionalLockFailures

java.util.Map<java.io.File,java.lang.String> getAdditionalLockFailures()

Get the other lock failures.

These are lock failure that have other causes than already locked or out of date elements.

Returns:

a map with as key the reference that couldn't be locked, and the reason as value.

getAdditionalOutdatedFiles

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

Get the additional files that couldn't be locked because they are out of date.

Returns:

the out-dated files.