org.sandev.basics.sandmessages
Class ReceiveReturn

java.lang.Object
  org.sandev.basics.structs.ReceiveReturnStruct
      org.sandev.basics.sandmessages.ReceiveReturn

All Implemented Interfaces:

Resolvable, SandInstanceMessage, SandMessage, SandStructMessage

public class ReceiveReturn

extends ReceiveReturnStruct

implements SandStructMessage, Resolvable

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

Field Summary

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

query, response

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

ReceiveReturn()
Default constructor calls init.

Method Summary

SandInstanceMessage	cloneMessage() Calls cloneReceiveReturn
ReceiveReturn	cloneReceiveReturn() Make a deep copy of this ReceiveReturn.
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(ReceiveReturn 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	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	getQuery() Accessor for query
static MessageDescription	getQueryDefaultValue() Default value for query.
java.lang.String	getQueryFieldPrintValue() Return the print name of the query field.
static boolean	getQueryFlag(int fieldflag) Field flag accessor.
static MessageDescription	getQueryInvalidValue() Invalid value for query.
SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getQueryMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getQueryPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getQueryRange() Return the range specification for this field
java.lang.String	getQueryValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandMessage	getResponse() Accessor for response
static SandMessage	getResponseDefaultValue() Default value for response.
java.lang.String	getResponseFieldPrintValue() Return the print name of the response field.
static boolean	getResponseFlag(int fieldflag) Field flag accessor.
static SandMessage	getResponseInvalidValue() Invalid value for response.
java.lang.String	getResponseMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getResponsePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getResponseRange() Return the range specification for this field
java.lang.String	getResponseValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getShortName() Returns the unqualified name of this message.
SandStructMessage	getStructMessage() Returns a new ReceiveReturn 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
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.
void	setQuery(MessageDescription query) Mutator for query
void	setQuery(java.lang.Object query) Generic mutator for query
void	setResponse(java.lang.Object response) Generic mutator for response
void	setResponse(SandMessage response) Mutator for response
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

ReceiveReturn

public ReceiveReturn()

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

getQuery

public MessageDescription getQuery()

Accessor for query

setQuery

public void setQuery(MessageDescription query)

Mutator for query

setQuery

public void setQuery(java.lang.Object query)

Generic mutator for query

getQueryFlag

public static boolean getQueryFlag(int fieldflag)

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

getQueryDefaultValue

public static MessageDescription getQueryDefaultValue()

Default value for query. Returns null

getQueryInvalidValue

public static MessageDescription getQueryInvalidValue()

Invalid value for query. Returns null

getQueryPrintValue

public java.lang.String getQueryPrintValue()

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.

getQueryFieldPrintValue

public java.lang.String getQueryFieldPrintValue()

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

getQueryRange

public java.lang.String getQueryRange()

Return the range specification for this field

getQueryValidityCheck

public java.lang.String getQueryValidityCheck()

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.

getQueryMetatype

public java.lang.String getQueryMetatype()

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

getResponse

public SandMessage getResponse()

Accessor for response

setResponse

public void setResponse(SandMessage response)

Mutator for response

setResponse

public void setResponse(java.lang.Object response)

Generic mutator for response

getResponseFlag

public static boolean getResponseFlag(int fieldflag)

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

getResponseDefaultValue

public static SandMessage getResponseDefaultValue()

Default value for response. Returns null

getResponseInvalidValue

public static SandMessage getResponseInvalidValue()

Invalid value for response. Returns null

getResponsePrintValue

public java.lang.String getResponsePrintValue()

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.

getResponseFieldPrintValue

public java.lang.String getResponseFieldPrintValue()

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

getResponseRange

public java.lang.String getResponseRange()

Return the range specification for this field

getResponseValidityCheck

public java.lang.String getResponseValidityCheck()

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.

getResponseMetatype

public java.lang.String getResponseMetatype()

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 ReceiveReturn 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 cloneReceiveReturn

Specified by:

cloneMessage in interface SandInstanceMessage

cloneReceiveReturn

public ReceiveReturn cloneReceiveReturn()

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

copyDataFrom

public void copyDataFrom(ReceiveReturn 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