org.sandev.basics.sandmessages
Class DeliveryStream

java.lang.Object
  org.sandev.basics.structs.DeliveryStreamStruct
      org.sandev.basics.sandmessages.DeliveryStream

All Implemented Interfaces:

Resolvable, SandInstanceMessage, SandMessage, SandStructMessage

public class DeliveryStream

extends DeliveryStreamStruct

implements SandStructMessage, Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.DeliveryStreamStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:50 PM

Field Summary

Fields inherited from class org.sandev.basics.structs.DeliveryStreamStruct

erroneousInput, expectedInput, sourceInstanceName

Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage

FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Constructor Summary

DeliveryStream()
Default constructor calls init.

Method Summary

void	addErroneousInput(MessageDescription element) Appends a value to erroneousInput
void	addErroneousInput(MessageDescription[] elements) Appends an array of values to erroneousInput
void	addExpectedInput(MessageDescription element) Appends a value to expectedInput
void	addExpectedInput(MessageDescription[] elements) Appends an array of values to expectedInput
void	clearErroneousInput() Clears all values from erroneousInput
void	clearExpectedInput() Clears all values from expectedInput
DeliveryStream	cloneDeliveryStream() Make a deep copy of this DeliveryStream.
SandInstanceMessage	cloneMessage() Calls cloneDeliveryStream
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(DeliveryStream other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	erroneousInputContains(MessageDescription val) Returns true if erroneousInput contains the specified value.
int	erroneousInputIndexOf(MessageDescription val) Return the index of the specified value in erroneousInput, or -1 if not found.
boolean	expectedInputContains(MessageDescription val) Returns true if expectedInput contains the specified value.
int	expectedInputIndexOf(MessageDescription val) Return the index of the specified value in expectedInput, or -1 if not found.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
SandAttrVal[]	fieldValidate(SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(IDLookup lookup, AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
MessageDescription[]	getErroneousInput() Accessor for erroneousInput
MessageDescription	getErroneousInput(int index) Returns the element at the specified index.
static MessageDescription[]	getErroneousInputDefaultValue() Default value for erroneousInput.
static MessageDescription	getErroneousInputElementInvalidValue() Invalid value for erroneousInputelement.
static boolean	getErroneousInputFlag(int fieldflag) Field flag accessor.
static MessageDescription[]	getErroneousInputInvalidValue() Invalid value for erroneousInput.
java.lang.String	getErroneousInputMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getErroneousInputRange() Return the range specification for this field
java.lang.String	getErroneousInputValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
MessageDescription[]	getExpectedInput() Accessor for expectedInput
MessageDescription	getExpectedInput(int index) Returns the element at the specified index.
static MessageDescription[]	getExpectedInputDefaultValue() Default value for expectedInput.
static MessageDescription	getExpectedInputElementInvalidValue() Invalid value for expectedInputelement.
static boolean	getExpectedInputFlag(int fieldflag) Field flag accessor.
static MessageDescription[]	getExpectedInputInvalidValue() Invalid value for expectedInput.
java.lang.String	getExpectedInputMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getExpectedInputRange() Return the range specification for this field
java.lang.String	getExpectedInputValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getShortName() Returns the unqualified name of this message.
java.lang.String	getSourceInstanceName() Accessor for sourceInstanceName
static java.lang.String	getSourceInstanceNameDefaultValue() Default value for sourceInstanceName.
java.lang.String	getSourceInstanceNameFieldPrintValue() Return the print name of the sourceInstanceName field.
static boolean	getSourceInstanceNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getSourceInstanceNameInvalidValue() Invalid value for sourceInstanceName.
static int	getSourceInstanceNameLengthMax() Maximum sourceInstanceName length is 80 characters
static int	getSourceInstanceNameLengthNorm() Normal sourceInstanceName length is 30 characters
java.lang.String	getSourceInstanceNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSourceInstanceNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSourceInstanceNameRange() Return the range specification for this field
java.lang.String	getSourceInstanceNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandStructMessage	getStructMessage() Returns a new DeliveryStream instance
SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
void	insertErroneousInput(int index, MessageDescription value) Insert the specified element at the specified index.
void	insertExpectedInput(int index, MessageDescription value) Insert the specified element at the specified index.
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au) Validate the references as specified in the Resolvable interface.
MessageDescription	removeErroneousInput(int index) Remove the element at the specified index and return it.
boolean	removeErroneousInputValue(MessageDescription value) Removes the given element from erroneousInput.
MessageDescription	removeExpectedInput(int index) Remove the element at the specified index and return it.
boolean	removeExpectedInputValue(MessageDescription value) Removes the given element from expectedInput.
void	setErroneousInput(int index, MessageDescription value) Set the value at the index specified.
void	setErroneousInput(MessageDescription[] erroneousInput) Mutator for erroneousInput
void	setErroneousInput(java.lang.Object[] erroneousInput) Generic mutator for erroneousInput
void	setExpectedInput(int index, MessageDescription value) Set the value at the index specified.
void	setExpectedInput(MessageDescription[] expectedInput) Mutator for expectedInput
void	setExpectedInput(java.lang.Object[] expectedInput) Generic mutator for expectedInput
void	setSourceInstanceName(java.lang.Object sourceInstanceName) Generic mutator for sourceInstanceName
void	setSourceInstanceName(java.lang.String sourceInstanceName) Mutator for sourceInstanceName
int	sizeofErroneousInput() Returns the size of erroneousInput.
int	sizeofExpectedInput() Returns the size of expectedInput.
java.lang.String	toString() Return a string representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeliveryStream

public DeliveryStream()

Default constructor calls init.

Method Detail

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)

Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.

Specified by:

fieldHasFlag in interface SandInstanceMessage

getSourceInstanceName

public java.lang.String getSourceInstanceName()

Accessor for sourceInstanceName

setSourceInstanceName

public void setSourceInstanceName(java.lang.String sourceInstanceName)

Mutator for sourceInstanceName

setSourceInstanceName

public void setSourceInstanceName(java.lang.Object sourceInstanceName)

Generic mutator for sourceInstanceName

getSourceInstanceNameFlag

public static boolean getSourceInstanceNameFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getSourceInstanceNameLengthNorm

public static int getSourceInstanceNameLengthNorm()

Normal sourceInstanceName length is 30 characters

getSourceInstanceNameLengthMax

public static int getSourceInstanceNameLengthMax()

Maximum sourceInstanceName length is 80 characters

getSourceInstanceNameDefaultValue

public static java.lang.String getSourceInstanceNameDefaultValue()

Default value for sourceInstanceName. Returns ""

getSourceInstanceNameInvalidValue

public static java.lang.String getSourceInstanceNameInvalidValue()

Invalid value for sourceInstanceName. Returns "SANDEV_INVALID_INSTANCENAME"

getSourceInstanceNamePrintValue

public java.lang.String getSourceInstanceNamePrintValue()

Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getSourceInstanceNameFieldPrintValue

public java.lang.String getSourceInstanceNameFieldPrintValue()

Return the print name of the sourceInstanceName field. If no printname is declared then this returns the field name.

getSourceInstanceNameRange

public java.lang.String getSourceInstanceNameRange()

Return the range specification for this field

getSourceInstanceNameValidityCheck

public java.lang.String getSourceInstanceNameValidityCheck()

Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getSourceInstanceNameMetatype

public java.lang.String getSourceInstanceNameMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getExpectedInput

public MessageDescription[] getExpectedInput()

Accessor for expectedInput

setExpectedInput

public void setExpectedInput(MessageDescription[] expectedInput)

Mutator for expectedInput

setExpectedInput

public void setExpectedInput(java.lang.Object[] expectedInput)

Generic mutator for expectedInput

addExpectedInput

public void addExpectedInput(MessageDescription element)

Appends a value to expectedInput

addExpectedInput

public void addExpectedInput(MessageDescription[] elements)

Appends an array of values to expectedInput

getExpectedInput

public MessageDescription getExpectedInput(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setExpectedInput

public void setExpectedInput(int index,
                             MessageDescription value)

Set the value at the index specified.

insertExpectedInput

public void insertExpectedInput(int index,
                                MessageDescription value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeExpectedInput

public MessageDescription removeExpectedInput(int index)

Remove the element at the specified index and return it.

removeExpectedInputValue

public boolean removeExpectedInputValue(MessageDescription value)

Removes the given element from expectedInput. Returns true if the element was found.

clearExpectedInput

public void clearExpectedInput()

Clears all values from expectedInput

expectedInputContains

public boolean expectedInputContains(MessageDescription val)

Returns true if expectedInput contains the specified value.

expectedInputIndexOf

public int expectedInputIndexOf(MessageDescription val)

Return the index of the specified value in expectedInput, or -1 if not found.

sizeofExpectedInput

public int sizeofExpectedInput()

Returns the size of expectedInput. Returns -1 if expectedInput is null.

getExpectedInputFlag

public static boolean getExpectedInputFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getExpectedInputDefaultValue

public static MessageDescription[] getExpectedInputDefaultValue()

Default value for expectedInput. Returns new MessageDescription[0]

getExpectedInputElementInvalidValue

public static MessageDescription getExpectedInputElementInvalidValue()

Invalid value for expectedInputelement. Returns null

getExpectedInputInvalidValue

public static MessageDescription[] getExpectedInputInvalidValue()

Invalid value for expectedInput. Returns null

getExpectedInputRange

public java.lang.String getExpectedInputRange()

Return the range specification for this field

getExpectedInputValidityCheck

public java.lang.String getExpectedInputValidityCheck()

Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getExpectedInputMetatype

public java.lang.String getExpectedInputMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getErroneousInput

public MessageDescription[] getErroneousInput()

Accessor for erroneousInput

setErroneousInput

public void setErroneousInput(MessageDescription[] erroneousInput)

Mutator for erroneousInput

setErroneousInput

public void setErroneousInput(java.lang.Object[] erroneousInput)

Generic mutator for erroneousInput

addErroneousInput

public void addErroneousInput(MessageDescription element)

Appends a value to erroneousInput

addErroneousInput

public void addErroneousInput(MessageDescription[] elements)

Appends an array of values to erroneousInput

getErroneousInput

public MessageDescription getErroneousInput(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setErroneousInput

public void setErroneousInput(int index,
                              MessageDescription value)

Set the value at the index specified.

insertErroneousInput

public void insertErroneousInput(int index,
                                 MessageDescription value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeErroneousInput

public MessageDescription removeErroneousInput(int index)

Remove the element at the specified index and return it.

removeErroneousInputValue

public boolean removeErroneousInputValue(MessageDescription value)

Removes the given element from erroneousInput. Returns true if the element was found.

clearErroneousInput

public void clearErroneousInput()

Clears all values from erroneousInput

erroneousInputContains

public boolean erroneousInputContains(MessageDescription val)

Returns true if erroneousInput contains the specified value.

erroneousInputIndexOf

public int erroneousInputIndexOf(MessageDescription val)

Return the index of the specified value in erroneousInput, or -1 if not found.

sizeofErroneousInput

public int sizeofErroneousInput()

Returns the size of erroneousInput. Returns -1 if erroneousInput is null.

getErroneousInputFlag

public static boolean getErroneousInputFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getErroneousInputDefaultValue

public static MessageDescription[] getErroneousInputDefaultValue()

Default value for erroneousInput. Returns new MessageDescription[0]

getErroneousInputElementInvalidValue

public static MessageDescription getErroneousInputElementInvalidValue()

Invalid value for erroneousInputelement. Returns null

getErroneousInputInvalidValue

public static MessageDescription[] getErroneousInputInvalidValue()

Invalid value for erroneousInput. Returns null

getErroneousInputRange

public java.lang.String getErroneousInputRange()

Return the range specification for this field

getErroneousInputValidityCheck

public java.lang.String getErroneousInputValidityCheck()

Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getErroneousInputMetatype

public java.lang.String getErroneousInputMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:

getShortName in interface SandMessage

getQueryMessage

public SandQueryMessage getQueryMessage()

Returns null

Specified by:

getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()

Returns null

Specified by:

getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()

Returns null

Specified by:

getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new DeliveryStream instance

Specified by:

getStructMessage in interface SandMessage

isEquivalent

public boolean isEquivalent(SandMessage sm)

Declared field equivalence check as specified by the SandMessage interface. String values are trimmed before comparison because conversions may occasionally result in trailing whitespace, which should not cause equivalence comparisons to fail. Comparisons are case insensitive since that corresponds to what most people expect, and how most databases work.

Specified by:

isEquivalent in interface SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws SandException

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

generalModifier in interface SandInstanceMessage

Throws:

SandException

generalDereference

public SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalDereference in interface SandInstanceMessage

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalAccessor in interface SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

Return an array of the summary field names for this class.

Specified by:

getDisplayFields in interface SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues()

Return the values for the summary fields. The standard String representation of each value is returned. For Dates, the default DateFormat output is used. For enums, the print value is used. These can be further transformed as needed.

Specified by:

getDisplayValues in interface SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues(IDLookup lookup,
                                           AuthUser user,
                                           java.lang.String defaultVal)

Return the values for the summary fields, including dereference expressions.

Specified by:

getDisplayValues in interface Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             IDLookup lookup,
                                             AuthUser user,
                                             java.lang.String defaultVal)

Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

toString

public java.lang.String toString()

Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

getAllFields in interface SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

defaultField in interface SandInstanceMessage

cloneMessage

public SandInstanceMessage cloneMessage()

Calls cloneDeliveryStream

Specified by:

cloneMessage in interface SandInstanceMessage

cloneDeliveryStream

public DeliveryStream cloneDeliveryStream()

Make a deep copy of this DeliveryStream. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(DeliveryStream other)

Deep copy all the data from the specified instance. If the other instance is null then this method does nothing.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

copyFieldValue in interface SandInstanceMessage

fieldValidate

public SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldValidate in interface SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldsValid in interface SandInstanceMessage

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            IDLookup idlookup,
                                            NameLookup namelookup,
                                            AuthUser au)
                                     throws SandException

Validate the references as specified in the Resolvable interface.

Specified by:

referenceValidate in interface Resolvable

Throws:

SandException

convertToSuperstructClass

public SandInstanceMessage convertToSuperstructClass()

Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:

convertToSuperstructClass in interface SandInstanceMessage

debugDump

public java.lang.String debugDump(java.lang.String prefix)

Dump this instance into a debug printable string.

Specified by:

debugDump in interface SandInstanceMessage