org.openlowcode.tools.structure

Class TimePeriodDataElt

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.tools.structure.DataElt

org.openlowcode.tools.structure.SimpleDataElt

org.openlowcode.tools.structure.TimePeriodDataElt

All Implemented Interfaces:

NamedInterface

public class TimePeriodDataElt
extends SimpleDataElt

Constructor Summary

Constructors

Constructor and Description
TimePeriodDataElt(java.lang.String name)
TimePeriodDataElt(java.lang.String name, TimePeriod payload)

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)
SimpleDataElt	cloneElt() makes a deep copy of the element
java.lang.String	defaultTextRepresentation()
void	forceContent(java.lang.String constraintvalue)
protected java.lang.Object	getMessageArrayValue()
protected MessageFieldSpec	getMessageFieldSpec()
TimePeriod	getPayload()
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, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

TimePeriodDataElt

public TimePeriodDataElt(java.lang.String name,
                         TimePeriod payload)

TimePeriodDataElt

public TimePeriodDataElt(java.lang.String name)

Method Detail

cloneElt

public SimpleDataElt cloneElt()

Description copied from class: SimpleDataElt

makes a deep copy of the element

Specified by:

cloneElt in class SimpleDataElt

Returns:

the deep copy

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

defaultTextRepresentation

public java.lang.String defaultTextRepresentation()

Specified by:

defaultTextRepresentation in class SimpleDataElt

Returns:

a simple text representation for audit and log purposes

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

getMessageFieldSpec

protected MessageFieldSpec getMessageFieldSpec()

Specified by:

getMessageFieldSpec in class SimpleDataElt

Returns:

gets the Message Field Spec

getMessageArrayValue

protected java.lang.Object getMessageArrayValue()

Specified by:

getMessageArrayValue in class SimpleDataElt

Returns:

the vale of an object in the message array

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 TimePeriod getPayload()