com.whitestein.lsps.engine

Interface ModelInstanceUtilsService

All Known Implementing Classes:

ModelInstanceUtilsServiceBean

public interface ModelInstanceUtilsService

Service for merging evaluation levels.

Author:

bhl

Method Summary

Modifier and Type	Method and Description
AllocatedModelInstanceResources	allocateDetachmentAndValueIds(long modelInstanceId, long allocatedSize) Allocates new range of value ids and detachment id.
AllocatedModelInstanceResources	allocateValueIds(long modelInstanceId, long allocatedSize) Allocates new range of value ids.
void	attach(ModelInstance modelInstance) If a model instance is detached it is attached to the original.
void	attachAndMergeLevel(ModelInstance modelInstance, String level) If a model instance is detached it is attached to the original and state of specified evaluation level is merged to lower level.
Set<RecordValue>	getOptimisticLockConflicts(ModelInstance modelInstance, Collection<String> levels, boolean resetVersionForUnchanged) Returns records that will have optimistic lock conflicts when merged to base level.
boolean	isDirty(ModelInstance modelInstance) Returns true if there are changes in no-base evaluation level that can affect existing data in the base level.
boolean	isDirty(ModelInstance modelInstance, Collection<String> ignoreLevels) Returns true if there are changes in no-base evaluation level that can affect existing data in the base level.
void	reloadChangedRecordVersions(ModelInstance modelInstance) Resets version of versioned higher level shared records.
void	resetUnchangedRecordVersions(ModelInstance modelInstance) Resets version of unchanged versioned higher level shared records.
void	saveModelInstance(ModelInstance modelInstance) Saves model instance to model instance entity.

Method Detail

attachAndMergeLevel

void attachAndMergeLevel(ModelInstance modelInstance,
                         String level)
                  throws LspsException

If a model instance is detached it is attached to the original and state of specified evaluation level is merged to lower level. Merge is executed in the existing transaction.

Parameters:

modelInstance -

level -

Throws:

LspsException

attach

void attach(ModelInstance modelInstance)
     throws LspsException

If a model instance is detached it is attached to the original. It means that changes of variables and non-shared records from detached model instance are set to the original model instance. Records created in the detached model instance are added to the original model instance and deleted records are removed. All this is done only if there is no optimistic lock conflicts on changed values. Record change proxy objects are handled as regular records during the attach. The attach does not work for evaluation levels. If evaluation levels are used the method attachAndMergeLevel(ModelInstance, String) must be used. state of specified evaluation level is merged to lower level. Merge is executed in the existing transaction.

Parameters:

modelInstance -

Throws:

LspsException

saveModelInstance

void saveModelInstance(ModelInstance modelInstance)
                throws ModelInstanceNotFoundException

Saves model instance to model instance entity.

Parameters:

modelInstance -

Throws:

ModelInstanceNotFoundException

resetUnchangedRecordVersions

void resetUnchangedRecordVersions(ModelInstance modelInstance)

Resets version of unchanged versioned higher level shared records.

Parameters:

modelInstance -

reloadChangedRecordVersions

void reloadChangedRecordVersions(ModelInstance modelInstance)

Resets version of versioned higher level shared records.

Parameters:

modelInstance -

isDirty

boolean isDirty(ModelInstance modelInstance)

Returns true if there are changes in no-base evaluation level that can affect existing data in the base level. In other words it returns true if there are unsaved changes in a document or todo.

Parameters:

modelInstance -

Returns:

true if there are unsaved changes in a document or todo

isDirty

boolean isDirty(ModelInstance modelInstance,
                Collection<String> ignoreLevels)

Returns true if there are changes in no-base evaluation level that can affect existing data in the base level. In other words it returns true if there are unsaved changes in a document or todo.

Parameters:

modelInstance -

ignoreLevels - a collection of levels that should be ignored

Returns:

true if there are unsaved changes in a document or todo

getOptimisticLockConflicts

Set<RecordValue> getOptimisticLockConflicts(ModelInstance modelInstance,
                                            Collection<String> levels,
                                            boolean resetVersionForUnchanged)

Returns records that will have optimistic lock conflicts when merged to base level.

Parameters:

modelInstance -

levels -

resetVersionForUnchanged -

Returns:

records that will have optimistic lock conflicts when merged to base level

allocateValueIds

AllocatedModelInstanceResources allocateValueIds(long modelInstanceId,
                                                 long allocatedSize)

Allocates new range of value ids.

Parameters:

modelInstanceId -

allocatedSize -

Returns:

new range of value ids

allocateDetachmentAndValueIds

AllocatedModelInstanceResources allocateDetachmentAndValueIds(long modelInstanceId,
                                                              long allocatedSize)

Allocates new range of value ids and detachment id.

Parameters:

modelInstanceId -

allocatedSize -

Returns:

new range of value ids and detachment id