com.whitestein.lsps.lang.exec

Interface RecordHolder

All Superinterfaces:

AssociationHandler, ValueHolder

All Known Implementing Classes:

AchieveGoalHolder, AnyPerformerHolder, CompiledRecord, CompiledRecordProxySetHolder, ExternalRecordHolder, ExternalRecordHolderBase, ExternalRecordValue, GoalHolder, GoalPlanHolder, InternalRecordHolder, MaintainGoalHolder, MockRecordHolder, PlanHolder, ProcessInstanceHolder, ReadOnlyRecordHolder, RecordHolderBase, RecordProxySetHolder, RecordValue, RoleUnitHolder

public interface RecordHolder
extends ValueHolder, AssociationHandler

All objects of the type RecordType must implement this interface.

Author:

rba

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns a map view of this record.
RecordHolder	createChangeProxy(RecordHolder proxySet, boolean isLazySpreading) Creates change proxy on this record holder.
void	createPropertyProxy(HolderFactory holderFactory, String property, RecordHolder proxySet) Creates change proxy for all object referenced by the propery and sets the proxy values to the property.
Object	executeMethod(Namespace parentNamespace, FunctionSignature signature, Object... arguments) Executes method with parameters.
long	getBaseLevelEntityId() Returns id of the corresponding record in the base level.
RecordHolder	getBaseLevelHolder() Returns base level record holder.
RecordHolder	getCompiled(Object compiledContext) Returns instance of the compiled record for this record holder.
String	getEvaluationLevel() Returns the evaluation level.
String	getIdentificationString() Returns identification string (string form of primary key)
Object	getJavaIdentification() Returns identification in plain java form.
Object	getJavaObject() Returns underlying java object if there is some.
Namespace	getNamespace(Namespace parentNamespace) Returns namespace of this record.
RecordHolder	getOriginalRecord() Returns proxied record that is not proxy.
Object	getProperty(String name) Returns the property given the property name, if no such property exists, exception is thrown.
RecordHolder	getProxiedRecord() Returns proxied record of this record.
int	getProxyLevel() For original record it returns 0.
RecordHolder	getProxySet() Returns proxySet of this record.
RecordHolder	getRecordOnProxyLevel(int proxyLevel) Returns record with the defined proxy level or with the smaller level if such does not exist.
RecordType	getType() Returns the type of the holder.
Long	getVersion() Returns version in string format.
boolean	hasOptimisticLockRelevantChanges() Returns true if record has changes of properties that affect optimistic lock version.
boolean	isProxy() Returns true if record is proxy.
boolean	isRemoved() Returns true if the record is removed from the model instance.
RecordHolder	mergeChanges(Namespace namespace, boolean checkConflicts) If this is wrapper it merges all its changes to the wrapped record.
void	remove(boolean isCascaded) Removes record.
void	setCompiled(RecordHolder compiled) Set instance of compiled record.
void	setProperty(String name, Object value) Sets the property given the property name.

Methods inherited from interface com.whitestein.lsps.lang.exec.ValueHolder

getId, getNotCompiledValueHolder

Methods inherited from interface com.whitestein.lsps.lang.exec.AssociationHandler

isUpdateNecessary, setThisSideOfAssociation

Method Detail

getType

RecordType getType()

Description copied from interface: ValueHolder

Returns the type of the holder.

Specified by:

getType in interface ValueHolder

Returns:

the type of the holder

getProperty

Object getProperty(String name)

Returns the property given the property name, if no such property exists, exception is thrown.

Parameters:

name -

Returns:

the property given the property name

Throws:

NullPointerException - if name is null

IllegalArgumentException - if no property named name exists

setProperty

void setProperty(String name,
                 Object value)

Sets the property given the property name.

Parameters:

name -

value -

Throws:

NullPointerException - if name is null

IllegalArgumentException - if no property named name exists

getIdentificationString

String getIdentificationString()

Returns identification string (string form of primary key)

Returns:

identification string

getVersion

Long getVersion()

Returns version in string format.

Returns:

version in string format

getJavaIdentification

Object getJavaIdentification()

Returns identification in plain java form.

Returns:

identification in plain java form

asMap

Map<String,Object> asMap()

Returns a map view of this record.

Returns:

a map view of this record

remove

void remove(boolean isCascaded)

Removes record. If cascaded removes also orphaned entities.

Parameters:

isCascaded -

getEvaluationLevel

String getEvaluationLevel()

Returns the evaluation level.

Returns:

evaluation level

getBaseLevelEntityId

long getBaseLevelEntityId()

Returns id of the corresponding record in the base level.

Returns:

id of the corresponding record in the base level

getBaseLevelHolder

RecordHolder getBaseLevelHolder()

Returns base level record holder.

Returns:

base level record holder

hasOptimisticLockRelevantChanges

boolean hasOptimisticLockRelevantChanges()

Returns true if record has changes of properties that affect optimistic lock version.

Returns:

true if record has changes of properties that affect optimistic lock version

isRemoved

boolean isRemoved()

Returns true if the record is removed from the model instance.

Returns:

true if the record is removed from the model instance

getNamespace

Namespace getNamespace(Namespace parentNamespace)

Returns namespace of this record.

Parameters:

parentNamespace -

Returns:

namespace of this record

getJavaObject

Object getJavaObject()

Returns underlying java object if there is some. E.g. for pojo based shared records.

Returns:

underlying java object if there is some

createChangeProxy

RecordHolder createChangeProxy(RecordHolder proxySet,
                               boolean isLazySpreading)

Creates change proxy on this record holder. If the record already has proxy in the proxy set it returns the proxy. If a new proxy is created it is added to the proxy set. Proxy set can be null.

Parameters:

proxySet -

isLazySpreading -

Returns:

change proxy on this record holder

mergeChanges

RecordHolder mergeChanges(Namespace namespace,
                          boolean checkConflicts)
                   throws LspsException

If this is wrapper it merges all its changes to the wrapped record. It returns wrapped record of the record with applied changes.

Parameters:

namespace -

checkConflicts -

Returns:

wrapped record of the record with applied changes

Throws:

LspsException

getProxyLevel

int getProxyLevel()

For original record it returns 0. For proxy it returns "proxy level of "proxied record"+1.

Returns:

proxy level

getOriginalRecord

RecordHolder getOriginalRecord()

Returns proxied record that is not proxy.

Returns:

proxied record that is not proxy

getProxiedRecord

RecordHolder getProxiedRecord()

Returns proxied record of this record.

Returns:

proxied record of this record

getProxySet

RecordHolder getProxySet()

Returns proxySet of this record.

Returns:

proxySet of this record

getRecordOnProxyLevel

RecordHolder getRecordOnProxyLevel(int proxyLevel)

Returns record with the defined proxy level or with the smaller level if such does not exist. In other case returns null.

Parameters:

proxyLevel -

Returns:

record with the defined proxy level or with the smaller level if such does not exist

createPropertyProxy

void createPropertyProxy(HolderFactory holderFactory,
                         String property,
                         RecordHolder proxySet)

Creates change proxy for all object referenced by the propery and sets the proxy values to the property. If some of the proxy already exists in the proxy set it does not create new proxy. All new created proxies are added to the proxy set. Proxy set can be null.

Parameters:

holderFactory -

property -

proxySet -

isProxy

boolean isProxy()

Returns true if record is proxy.

Returns:

true if record is proxy

executeMethod

Object executeMethod(Namespace parentNamespace,
                     FunctionSignature signature,
                     Object... arguments)
              throws ErrorException

Executes method with parameters.

Parameters:

parentNamespace -

signature -

arguments -

Returns:

result of method execution

Throws:

ErrorException

getCompiled

RecordHolder getCompiled(Object compiledContext)

Returns instance of the compiled record for this record holder.

Parameters:

compiledContext -

Returns:

instance of the compiled record for this record holder

setCompiled

void setCompiled(RecordHolder compiled)

Set instance of compiled record.

Parameters:

compiled -