com.whitestein.lsps.engine.state.xml

Interface EvaluationLevelAware

All Superinterfaces:

Collectible, EntityWithId, ModelInstanceAware

All Known Implementing Classes:

CollectionValue, ComplexValue, Context, ExpressionValue, ExternalValue, ListValue, MapValue, RecordValue, SetValue

public interface EvaluationLevelAware
extends ModelInstanceAware, EntityWithId

Interface for evaluation aware elements.

Author:

bhl

Method Summary

Modifier and Type	Method and Description
void	clear() Clears evaluation data.
EvaluationLevelAware	getBaseLevelEntity() Returns element corresponding to this element in the base evaluation level.
Long	getBaseLevelEntityId() Returns id of element corresponding to this element in the base evaluation level.
String	getEvaluationLevel() Returns evaluation level.
EvaluationLevelAware	getLowerLevelEntity() Returns element corresponding to this element in the lower existing evaluation level.
Long	getLowerLevelEntityId() Returns id of element corresponding to this element in the lower existing evaluation level.
EvaluationLevelAware	getLowestLevelEntity() Returns element corresponding to this element in the lowest existing evaluation level.
Long	getLowestLevelEntityId() Returns id of element corresponding to this element in the lowest existing evaluation level.
String	internalVersionConflictMessage(EvaluationLevelAware entity) Returns message for internal versioning conflict.
boolean	isInternalyVersioned() Returns true if the entity is internally (in scope of model instance) versioned.
boolean	isLocked() Returns true if the entity is locked for modifications.
boolean	isLowestExistingEntity() Returns true if this entity is the lowest existing entity.
void	replaceIdAndEvaluationLevel(Long newId, Long newBaseId, String newEvaluationLevel) Replace id, base evaluation level entity id and evaluation level in the entity.
void	replaceReferencedIds(Map<Long,Long> replacementMap) Replace referenced ids to other entities in this entity.
void	updateLevelData(Long baseLevelEntityId, Long lowestLevelEntityId, Long lowerLevelEntityId) Updates references to the corresponding elements in other evaluation levels.

Methods inherited from interface com.whitestein.lsps.engine.state.xml.ModelInstanceAware

getModelInstance, rebind

Methods inherited from interface com.whitestein.lsps.engine.state.xml.EntityWithId

getId

Methods inherited from interface com.whitestein.lsps.engine.state.xml.Collectible

collect, getReferences, isPersistent

Method Detail

getEvaluationLevel

String getEvaluationLevel()

Returns evaluation level.

Returns:

evaluation level

getBaseLevelEntityId

Long getBaseLevelEntityId()

Returns id of element corresponding to this element in the base evaluation level. This id is always not null as it is used together with evaluation level to identify the element. If the element with this id does not exist it means that the id was reserved for the corresponding element in the base level, but so far such element was not created.

Returns:

id of element corresponding to this element in the base evaluation level

getBaseLevelEntity

EvaluationLevelAware getBaseLevelEntity()

Returns element corresponding to this element in the base evaluation level.

Returns:

element corresponding to this element in the base evaluation level

getLowestLevelEntityId

Long getLowestLevelEntityId()

Returns id of element corresponding to this element in the lowest existing evaluation level. This id is always not null.

Returns:

id of element corresponding to this element in the lowest existing evaluation level

getLowestLevelEntity

EvaluationLevelAware getLowestLevelEntity()

Returns element corresponding to this element in the lowest existing evaluation level.

Returns:

element corresponding to this element in the lowest existing evaluation level

getLowerLevelEntityId

Long getLowerLevelEntityId()

Returns id of element corresponding to this element in the lower existing evaluation level. This id can be null if the lower level does not exist.

Returns:

id of element corresponding to this element in the lower existing evaluation level

getLowerLevelEntity

EvaluationLevelAware getLowerLevelEntity()

Returns element corresponding to this element in the lower existing evaluation level.

Returns:

element corresponding to this element in the lower existing evaluation level

isLowestExistingEntity

boolean isLowestExistingEntity()

Returns true if this entity is the lowest existing entity.

Returns:

true if this entity is the lowest existing entity

updateLevelData

void updateLevelData(Long baseLevelEntityId,
                     Long lowestLevelEntityId,
                     Long lowerLevelEntityId)

Updates references to the corresponding elements in other evaluation levels.

Parameters:

baseLevelEntityId -

lowestLevelEntityId -

lowerLevelEntityId -

replaceIdAndEvaluationLevel

void replaceIdAndEvaluationLevel(Long newId,
                                 Long newBaseId,
                                 String newEvaluationLevel)

Replace id, base evaluation level entity id and evaluation level in the entity.

Parameters:

newId -

newBaseId -

newEvaluationLevel -

replaceReferencedIds

void replaceReferencedIds(Map<Long,Long> replacementMap)

Replace referenced ids to other entities in this entity.

Parameters:

replacementMap -

isLocked

boolean isLocked()

Returns true if the entity is locked for modifications.

Returns:

true if the entity is locked for modifications

isInternalyVersioned

boolean isInternalyVersioned()

Returns true if the entity is internally (in scope of model instance) versioned.

Returns:

true if the entity is internally (in scope of model instance) versioned

internalVersionConflictMessage

String internalVersionConflictMessage(EvaluationLevelAware entity)

Returns message for internal versioning conflict. Returns null if there is no conflict.

Parameters:

entity -

Returns:

message for internal versioning conflict

clear

void clear()

Clears evaluation data.