RecordValue (LSPS 3.2 SDK)

java.lang.Object
- com.whitestein.lsps.engine.dto.val.RecordValue

All Implemented Interfaces:

Value, AssociationHandler, RecordHolder, ValueHolder, Serializable

Direct Known Subclasses:

ExternalRecordValue
```
public class RecordValue
extends Object
implements Value, RecordHolder
```
A set value.

Author:

rba

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RecordValue()` Creates new instance.
	`RecordValue(RecordType type)` Creates new instance using the given type.
	`RecordValue(String type)` Creates new instance using the given type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent)`
`Map<String,Object>`	`asMap()` Returns a map view of this record.
`void`	`beforeUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent)`
`RecordHolder`	`createChangeProxy()` Creates change proxy on this record holder.
`void`	`createPropertyProxy(HolderFactory holderFactory, String property)` 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`	`getId()` Returns the id of this value, if any.
`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.
`ValueHolder`	`getNotCompiledValue()`
`RecordHolder`	`getOriginalRecord()` Returns proxied record that is not proxy.
`Value`	`getParent()` Returns the parent of this value.
`Object`	`getProperty(String name)` Returns the property given the property name, if no such property exists, exception is thrown.
`RecordHolder`	`getProxiedRecord()` Returns proxied record.
`int`	`getProxyLevel()` For original record it returns 0.
`RecordHolder`	`getRecordOnProxyLevel(int wrappingLevel)` Returns record on the defined proxy level or on the smaller level if such does not exist.
`RecordType`	`getType()` Returns the type of the holder.
`String`	`getVersionString()` 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.
`boolean`	`isUpdateNecessary(String property)` Returns true if association should be updated.
`RecordHolder`	`mergeChanges(Namespace namespace, boolean cascade, 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)`
`void`	`setProperty(String name, Object value)` Sets the property given the property name.
`void`	`setThisSideOfAssociation(String name, Object object)` Sets value only this side of the association.
`Object`	`toObject()` Converts this value to an appropriate object.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecordValue
```
protected RecordValue()
```
    Creates new instance.
  - RecordValue
```
public RecordValue(RecordType type)
```
    Creates new instance using the given type.
    
    Parameters:
    
    type -
  - RecordValue
```
public RecordValue(String type)
```
    Creates new instance using the given type.
    
    Parameters:
    
    type -
- Method Detail
  - toObject
```
public Object toObject()
```
    Description copied from interface: Value
    
    Converts this value to an appropriate object.
    
    Specified by:
    
    toObject in interface Value
    
    Returns:
    
    this value to an appropriate object
  - getId
```
public String getId()
```
    Description copied from interface: Value
    
    Returns the id of this value, if any.
    
    Specified by:
    
    getId in interface Value
    
    Specified by:
    
    getId in interface ValueHolder
    
    Returns:
    
    the id of this value, if any
  - getParent
```
public Value getParent()
```
    Description copied from interface: Value
    
    Returns the parent of this value.
    
    Specified by:
    
    getParent in interface Value
    
    Returns:
    
    the parent of this value
  - getType
```
public RecordType getType()
```
    Description copied from interface: ValueHolder
    
    Returns the type of the holder.
    
    Specified by:
    
    getType in interface RecordHolder
    
    Specified by:
    
    getType in interface ValueHolder
    
    Returns:
    
    the type of the holder
  - getProperty
```
public Object getProperty(String name)
```
    Description copied from interface: RecordHolder
    
    Returns the property given the property name, if no such property exists, exception is thrown.
    
    Specified by:
    
    getProperty in interface RecordHolder
    
    Returns:
    
    the property given the property name
  - setProperty
```
public void setProperty(String name,
                        Object value)
```
    Description copied from interface: RecordHolder
    
    Sets the property given the property name.
    
    Specified by:
    
    setProperty in interface RecordHolder
  - getIdentificationString
```
public String getIdentificationString()
```
    Description copied from interface: RecordHolder
    
    Returns identification string (string form of primary key)
    
    Specified by:
    
    getIdentificationString in interface RecordHolder
    
    Returns:
    
    identification string
  - getVersionString
```
public String getVersionString()
```
    Description copied from interface: RecordHolder
    
    Returns version in string format.
    
    Specified by:
    
    getVersionString in interface RecordHolder
    
    Returns:
    
    version in string format
  - getJavaIdentification
```
public Object getJavaIdentification()
```
    Description copied from interface: RecordHolder
    
    Returns identification in plain java form.
    
    Specified by:
    
    getJavaIdentification in interface RecordHolder
    
    Returns:
    
    identification in plain java form
  - asMap
```
public Map<String,Object> asMap()
```
    Description copied from interface: RecordHolder
    
    Returns a map view of this record.
    
    Specified by:
    
    asMap in interface RecordHolder
    
    Returns:
    
    a map view of this record
  - beforeUnmarshal
```
public void beforeUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                            Object parent)
```
  - afterUnmarshal
```
public void afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                           Object parent)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setThisSideOfAssociation
```
public void setThisSideOfAssociation(String name,
                                     Object object)
```
    Description copied from interface: AssociationHandler
    
    Sets value only this side of the association.
    
    Specified by:
    
    setThisSideOfAssociation in interface AssociationHandler
  - isUpdateNecessary
```
public boolean isUpdateNecessary(String property)
```
    Description copied from interface: AssociationHandler
    
    Returns true if association should be updated.
    
    Specified by:
    
    isUpdateNecessary in interface AssociationHandler
    
    Returns:
    
    true if association should be updated
  - remove
```
public void remove(boolean isCascaded)
```
    Description copied from interface: RecordHolder
    
    Removes record. If cascaded removes also orphaned entities.
    
    Specified by:
    
    remove in interface RecordHolder
  - getBaseLevelEntityId
```
public long getBaseLevelEntityId()
```
    Description copied from interface: RecordHolder
    
    Returns id of the corresponding record in the base level.
    
    Specified by:
    
    getBaseLevelEntityId in interface RecordHolder
    
    Returns:
    
    id of the corresponding record in the base level
  - getBaseLevelHolder
```
public RecordHolder getBaseLevelHolder()
```
    Description copied from interface: RecordHolder
    
    Returns base level record holder.
    
    Specified by:
    
    getBaseLevelHolder in interface RecordHolder
    
    Returns:
    
    base level record holder
  - hasOptimisticLockRelevantChanges
```
public boolean hasOptimisticLockRelevantChanges()
```
    Description copied from interface: RecordHolder
    
    Returns true if record has changes of properties that affect optimistic lock version.
    
    Specified by:
    
    hasOptimisticLockRelevantChanges in interface RecordHolder
    
    Returns:
    
    true if record has changes of properties that affect optimistic lock version
  - isRemoved
```
public boolean isRemoved()
```
    Description copied from interface: RecordHolder
    
    Returns true if the record is removed from the model instance.
    
    Specified by:
    
    isRemoved in interface RecordHolder
    
    Returns:
    
    true if the record is removed from the model instance
  - isProxy
```
public boolean isProxy()
```
    Description copied from interface: RecordHolder
    
    Returns true if record is proxy.
    
    Specified by:
    
    isProxy in interface RecordHolder
    
    Returns:
    
    true if record is proxy
  - mergeChanges
```
public RecordHolder mergeChanges(Namespace namespace,
                                 boolean cascade,
                                 boolean checkConflicts)
```
    Description copied from interface: RecordHolder
    
    If this is wrapper it merges all its changes to the wrapped record. If cascaded is false it merges only the record. If cascaded is true it merges changes from all wrappers that can be accessed from the record and has same wrapper level. It returns wrapped record of the record with applied changes.
    
    Specified by:
    
    mergeChanges in interface RecordHolder
    
    Returns:
    
    wrapped record of the record with applied changes
  - createChangeProxy
```
public RecordHolder createChangeProxy()
```
    Description copied from interface: RecordHolder
    
    Creates change proxy on this record holder.
    
    Specified by:
    
    createChangeProxy in interface RecordHolder
    
    Returns:
    
    change proxy on this record holder
  - getOriginalRecord
```
public RecordHolder getOriginalRecord()
```
    Description copied from interface: RecordHolder
    
    Returns proxied record that is not proxy.
    
    Specified by:
    
    getOriginalRecord in interface RecordHolder
    
    Returns:
    
    proxied record that is not proxy
  - getProxiedRecord
```
public RecordHolder getProxiedRecord()
```
    Description copied from interface: RecordHolder
    
    Returns proxied record.
    
    Specified by:
    
    getProxiedRecord in interface RecordHolder
    
    Returns:
  - getRecordOnProxyLevel
```
public RecordHolder getRecordOnProxyLevel(int wrappingLevel)
```
    Description copied from interface: RecordHolder
    
    Returns record on the defined proxy level or on the smaller level if such does not exist.
    
    Specified by:
    
    getRecordOnProxyLevel in interface RecordHolder
    
    Returns:
    
    proxied record on the defined proxy level or on the smaller level if such does not exist
  - getProxyLevel
```
public int getProxyLevel()
```
    Description copied from interface: RecordHolder
    
    For original record it returns 0. For proxy it returns "proxy level of "proxied record"+1.
    
    Specified by:
    
    getProxyLevel in interface RecordHolder
    
    Returns:
    
    proxy level
  - createPropertyProxy
```
public void createPropertyProxy(HolderFactory holderFactory,
                                String property)
```
    Description copied from interface: RecordHolder
    
    Creates change proxy for all object referenced by the propery and sets the proxy values to the property.
    
    Specified by:
    
    createPropertyProxy in interface RecordHolder
  - getNamespace
```
public Namespace getNamespace(Namespace parentNamespace)
```
    Description copied from interface: RecordHolder
    
    Returns namespace of this record.
    
    Specified by:
    
    getNamespace in interface RecordHolder
    
    Returns:
    
    namespace of this record
  - getJavaObject
```
public Object getJavaObject()
```
    Description copied from interface: RecordHolder
    
    Returns underlying java object if there is some. E.g. for pojo based shared records.
    
    Specified by:
    
    getJavaObject in interface RecordHolder
    
    Returns:
    
    underlying java object if there is some
  - executeMethod
```
public Object executeMethod(Namespace parentNamespace,
                            FunctionSignature signature,
                            Object... arguments)
```
    Description copied from interface: RecordHolder
    
    Executes method with parameters.
    
    Specified by:
    
    executeMethod in interface RecordHolder
    
    Returns:
    
    result of method execution
  - getCompiled
```
public RecordHolder getCompiled(Object compiledContext)
```
    Description copied from interface: RecordHolder
    
    Returns instance of the compiled record for this record holder.
    
    Specified by:
    
    getCompiled in interface RecordHolder
    
    Returns:
    
    instance of the compiled record for this record holder
  - setCompiled
```
public void setCompiled(RecordHolder compiled)
```
    Specified by:
    
    setCompiled in interface RecordHolder
  - getNotCompiledValue
```
public ValueHolder getNotCompiledValue()
```
    Specified by:
    
    getNotCompiledValue in interface ValueHolder

Class RecordValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordValue

RecordValue

RecordValue

Method Detail

toObject

getId

getParent

getType

getProperty

setProperty

getIdentificationString

getVersionString

getJavaIdentification

asMap

beforeUnmarshal

afterUnmarshal

toString

setThisSideOfAssociation

isUpdateNecessary

remove

getBaseLevelEntityId

getBaseLevelHolder

hasOptimisticLockRelevantChanges

isRemoved

isProxy

mergeChanges

createChangeProxy

getOriginalRecord

getProxiedRecord

getRecordOnProxyLevel

getProxyLevel

createPropertyProxy

getNamespace

getJavaObject

executeMethod

getCompiled

setCompiled

getNotCompiledValue