org.openlowcode.tools.structure

Class DecimalDataElt

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.tools.structure.DataElt

org.openlowcode.tools.structure.SimpleDataElt

org.openlowcode.tools.structure.DecimalDataElt

All Implemented Interfaces:

NamedInterface

public class DecimalDataElt
extends SimpleDataElt

A data element storing a decimal (java BigDecimal)

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
DecimalDataElt(java.lang.String name) creates a decimal data element
DecimalDataElt(java.lang.String name, java.math.BigDecimal payload)
DecimalDataElt(java.lang.String name, java.math.BigDecimal payload, boolean locked)

Method Summary

Modifier and Type	Method and Description
void	addPayload(MessageReader reader) for each element, should read and add content for all elements between the "TYP" field (excluded) and the "DELT" structure end (also excluded)
DecimalDataElt	cloneElt() makes a deep copy of the element
java.lang.String	defaultTextRepresentation()
boolean	equals(java.lang.Object other)
void	forceContent(java.lang.String constraintvalue)
protected java.lang.Object	getMessageArrayValue()
protected MessageFieldSpec	getMessageFieldSpec()
java.math.BigDecimal	getPayload()
boolean	islocked()
void	lockToValue(java.lang.String value)
void	setLocked(boolean locked)
void	unlockValue()
void	updatePayload(java.math.BigDecimal payload)
void	writePayload(MessageWriter writer) writes the payload for network transport

Methods inherited from class org.openlowcode.tools.structure.SimpleDataElt

getEltCreator, getPropertyname, setPropertyname, toString, WriteSpecToMessage, writeToMessage, writeToMessage

Methods inherited from class org.openlowcode.tools.structure.DataElt

getType, readFromCML, writeReferenceToCML

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DecimalDataElt

public DecimalDataElt(java.lang.String name,
                      java.math.BigDecimal payload)

DecimalDataElt

public DecimalDataElt(java.lang.String name,
                      java.math.BigDecimal payload,
                      boolean locked)

Parameters:

name - name of the element

payload - payload

locked - true to freeze the value

DecimalDataElt

public DecimalDataElt(java.lang.String name)

creates a decimal data element

Parameters:

name - name of the element

Method Detail

islocked

public boolean islocked()

setLocked

public void setLocked(boolean locked)

Parameters:

locked - change the value of the locked flag

writePayload

public void writePayload(MessageWriter writer)
                  throws java.io.IOException

Description copied from class: SimpleDataElt

writes the payload for network transport

Specified by:

writePayload in class SimpleDataElt

Parameters:

writer - writer

Throws:

java.io.IOException - if anything wrongs happens in the message sending

getMessageArrayValue

protected java.lang.Object getMessageArrayValue()

Specified by:

getMessageArrayValue in class SimpleDataElt

Returns:

the vale of an object in the message array

defaultTextRepresentation

public java.lang.String defaultTextRepresentation()

Specified by:

defaultTextRepresentation in class SimpleDataElt

Returns:

a simple text representation for audit and log purposes

addPayload

public void addPayload(MessageReader reader)
                throws OLcRemoteException,
                       java.io.IOException

Description copied from class: DataElt

for each element, should read and add content for all elements between the "TYP" field (excluded) and the "DELT" structure end (also excluded)

Overrides:

addPayload in class SimpleDataElt

Parameters:

reader - reader

Throws:

OLcRemoteException - if anything happened to the other party

java.io.IOException - if any communication error happens

getPayload

public java.math.BigDecimal getPayload()

updatePayload

public void updatePayload(java.math.BigDecimal payload)

cloneElt

public DecimalDataElt cloneElt()

Description copied from class: SimpleDataElt

makes a deep copy of the element

Specified by:

cloneElt in class SimpleDataElt

Returns:

the deep copy

lockToValue

public void lockToValue(java.lang.String value)

unlockValue

public void unlockValue()

forceContent

public void forceContent(java.lang.String constraintvalue)

Specified by:

forceContent in class SimpleDataElt

Parameters:

constraintvalue - force the content in payload. May not be implemented for all the types

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class Named

getMessageFieldSpec

protected MessageFieldSpec getMessageFieldSpec()

Specified by:

getMessageFieldSpec in class SimpleDataElt

Returns:

gets the Message Field Spec