org.sandev.basics.sandmessages
Class Ping

java.lang.Object
  org.sandev.basics.structs.PingStruct
      org.sandev.basics.sandmessages.Ping

All Implemented Interfaces:

Resolvable, SandInstanceMessage, SandMessage, SandStructMessage, SandTransmitMessage

public class Ping

extends PingStruct

implements SandStructMessage, Resolvable, SandTransmitMessage

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

Field Summary

static int	NODESTATUS_FAILED Possible value for nodeStatus
static int	NODESTATUS_FAILING Possible value for nodeStatus
static int	NODESTATUS_RESUMING Possible value for nodeStatus
static int	NODESTATUS_RUNNING Possible value for nodeStatus
static int	NODESTATUS_STARTING Possible value for nodeStatus
static int	NODESTATUS_STOPPED Possible value for nodeStatus
static int	NODESTATUS_STOPPING Possible value for nodeStatus
static int	NODESTATUS_SUSPENDED Possible value for nodeStatus
static int	NODESTATUS_SUSPENDING Possible value for nodeStatus
static int	NODESTATUS_UNDEFINED Possible value for nodeStatus
protected int	sandTransmissionCount Counter to aid in tracking receipt of sent messages.
protected long	sandTransmitAuthID The uniqueID of the authorized user of this message.
protected java.lang.String	sandTransmitErrorMessage Text details of the transmission error.
protected int	sandTransmitStatus Status of the message.

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

className, instanceName, nodeStatus

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

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

APPERROR_NODE_UNAVAILABLE, APPERROR_NODE_UNKNOWN, APPERROR_NODE_UNREACHABLE, STATUS_APPERROR, STATUS_NORMAL, STATUS_SANDERROR, STATUS_SYSERROR

Constructor Summary

Ping()
Default constructor calls init.

Method Summary

SandInstanceMessage	cloneMessage() Calls clonePing
Ping	clonePing() Make a deep copy of this Ping.
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(Ping 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.
java.lang.String	getClassName() Accessor for className
static java.lang.String	getClassNameDefaultValue() Default value for className.
java.lang.String	getClassNameFieldPrintValue() Return the print name of the className field.
static boolean	getClassNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getClassNameInvalidValue() Invalid value for className.
static int	getClassNameLengthMax() Maximum className length is 255 characters
static int	getClassNameLengthNorm() Normal className length is 65 characters
java.lang.String	getClassNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getClassNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getClassNameRange() Return the range specification for this field
java.lang.String	getClassNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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.
java.lang.String	getInstanceName() Accessor for instanceName
static java.lang.String	getInstanceNameDefaultValue() Default value for instanceName.
java.lang.String	getInstanceNameFieldPrintValue() Return the print name of the instanceName field.
static boolean	getInstanceNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getInstanceNameInvalidValue() Invalid value for instanceName.
static int	getInstanceNameLengthMax() Maximum instanceName length is 255 characters
static int	getInstanceNameLengthNorm() Normal instanceName length is 30 characters
java.lang.String	getInstanceNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getInstanceNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getInstanceNameRange() Return the range specification for this field
java.lang.String	getInstanceNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getNodeStatus() Accessor for nodeStatus
static java.lang.String[]	getNodeStatusActualVals() Return an array of the possible values for this field as Strings.
static int	getNodeStatusDefaultValue() Default value for nodeStatus.
static java.lang.String	getNodeStatusEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getNodeStatusFieldPrintValue() Return the print name of the nodeStatus field.
static boolean	getNodeStatusFlag(int fieldflag) Field flag accessor.
static int	getNodeStatusInvalidValue() Invalid value for nodeStatus.
static java.lang.String[]	getNodeStatusKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getNodeStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getNodeStatusPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getNodeStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNodeStatusRange() Return the range specification for this field
java.lang.String	getNodeStatusValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandQueryMessage	getQueryMessage() Returns null
int	getSandTransmissionCount() Accessor for sandTransmissionCount
static int	getSandTransmissionCountDefaultValue() Default value for sandTransmissionCount.
java.lang.String	getSandTransmissionCountFieldPrintValue() Return the print name of the sandTransmissionCount field.
static boolean	getSandTransmissionCountFlag(int fieldflag) Field flag accessor.
static int	getSandTransmissionCountInvalidValue() Invalid value for sandTransmissionCount.
java.lang.String	getSandTransmissionCountMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmissionCountPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmissionCountRange() Return the range specification for this field
java.lang.String	getSandTransmissionCountValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long	getSandTransmitAuthID() Accessor for sandTransmitAuthID
static long	getSandTransmitAuthIDDefaultValue() Default value for sandTransmitAuthID.
java.lang.String	getSandTransmitAuthIDFieldPrintValue() Return the print name of the sandTransmitAuthID field.
static boolean	getSandTransmitAuthIDFlag(int fieldflag) Field flag accessor.
static long	getSandTransmitAuthIDInvalidValue() Invalid value for sandTransmitAuthID.
java.lang.String	getSandTransmitAuthIDMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitAuthIDPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitAuthIDRange() Return the range specification for this field
java.lang.String	getSandTransmitAuthIDValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getSandTransmitErrorMessage() Accessor for sandTransmitErrorMessage
static java.lang.String	getSandTransmitErrorMessageDefaultValue() Default value for sandTransmitErrorMessage.
java.lang.String	getSandTransmitErrorMessageFieldPrintValue() Return the print name of the sandTransmitErrorMessage field.
static boolean	getSandTransmitErrorMessageFlag(int fieldflag) Field flag accessor.
static java.lang.String	getSandTransmitErrorMessageInvalidValue() Invalid value for sandTransmitErrorMessage.
static int	getSandTransmitErrorMessageLengthMax() Maximum sandTransmitErrorMessage length is 70 characters
static int	getSandTransmitErrorMessageLengthNorm() Normal sandTransmitErrorMessage length is 30 characters
java.lang.String	getSandTransmitErrorMessageMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitErrorMessagePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitErrorMessageRange() Return the range specification for this field
java.lang.String	getSandTransmitErrorMessageValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getSandTransmitStatus() Accessor for sandTransmitStatus
static int	getSandTransmitStatusDefaultValue() Default value for sandTransmitStatus.
java.lang.String	getSandTransmitStatusFieldPrintValue() Return the print name of the sandTransmitStatus field.
static boolean	getSandTransmitStatusFlag(int fieldflag) Field flag accessor.
static int	getSandTransmitStatusInvalidValue() Invalid value for sandTransmitStatus.
java.lang.String	getSandTransmitStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitStatusRange() Return the range specification for this field
java.lang.String	getSandTransmitStatusValidityCheck() 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 Ping 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.
static java.lang.String	nodeStatusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	nodeStatusLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	nodeStatusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	nodeStatusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	nodeStatusValueToLabel(int val) Given a value, return the declared label for it.
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	setClassName(java.lang.Object className) Generic mutator for className
void	setClassName(java.lang.String className) Mutator for className
void	setInstanceName(java.lang.Object instanceName) Generic mutator for instanceName
void	setInstanceName(java.lang.String instanceName) Mutator for instanceName
void	setNodeStatus(int nodeStatus) Mutator for nodeStatus
void	setSandTransmissionCount(int sandTransmissionCount) Mutator for sandTransmissionCount
void	setSandTransmitAuthID(long sandTransmitAuthID) Mutator for sandTransmitAuthID
void	setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage) Generic mutator for sandTransmitErrorMessage
void	setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage) Mutator for sandTransmitErrorMessage
void	setSandTransmitStatus(int sandTransmitStatus) Mutator for sandTransmitStatus
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

Field Detail

NODESTATUS_UNDEFINED

public static final int NODESTATUS_UNDEFINED

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_STOPPED

public static final int NODESTATUS_STOPPED

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_STARTING

public static final int NODESTATUS_STARTING

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_RUNNING

public static final int NODESTATUS_RUNNING

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_SUSPENDING

public static final int NODESTATUS_SUSPENDING

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_SUSPENDED

public static final int NODESTATUS_SUSPENDED

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_RESUMING

public static final int NODESTATUS_RESUMING

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_STOPPING

public static final int NODESTATUS_STOPPING

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_FAILING

public static final int NODESTATUS_FAILING

Possible value for nodeStatus

See Also:

Constant Field Values

NODESTATUS_FAILED

public static final int NODESTATUS_FAILED

Possible value for nodeStatus

See Also:

Constant Field Values

sandTransmitStatus

protected int sandTransmitStatus

Status of the message. Possible values are defined in SandTransmitMessage.

sandTransmitErrorMessage

protected java.lang.String sandTransmitErrorMessage

Text details of the transmission error.

sandTransmissionCount

protected int sandTransmissionCount

Counter to aid in tracking receipt of sent messages.

sandTransmitAuthID

protected long sandTransmitAuthID

The uniqueID of the authorized user of this message.

Constructor Detail

Ping

public Ping()

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

getClassName

public java.lang.String getClassName()

Accessor for className

setClassName

public void setClassName(java.lang.String className)

Mutator for className

setClassName

public void setClassName(java.lang.Object className)

Generic mutator for className

getClassNameFlag

public static boolean getClassNameFlag(int fieldflag)

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

getClassNameLengthNorm

public static int getClassNameLengthNorm()

Normal className length is 65 characters

getClassNameLengthMax

public static int getClassNameLengthMax()

Maximum className length is 255 characters

getClassNameDefaultValue

public static java.lang.String getClassNameDefaultValue()

Default value for className. Returns ""

getClassNameInvalidValue

public static java.lang.String getClassNameInvalidValue()

Invalid value for className. Returns "SANDEV_INVALID_CLASSNAME"

getClassNamePrintValue

public java.lang.String getClassNamePrintValue()

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.

getClassNameFieldPrintValue

public java.lang.String getClassNameFieldPrintValue()

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

getClassNameRange

public java.lang.String getClassNameRange()

Return the range specification for this field

getClassNameValidityCheck

public java.lang.String getClassNameValidityCheck()

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.

getClassNameMetatype

public java.lang.String getClassNameMetatype()

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

getInstanceName

public java.lang.String getInstanceName()

Accessor for instanceName

setInstanceName

public void setInstanceName(java.lang.String instanceName)

Mutator for instanceName

setInstanceName

public void setInstanceName(java.lang.Object instanceName)

Generic mutator for instanceName

getInstanceNameFlag

public static boolean getInstanceNameFlag(int fieldflag)

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

getInstanceNameLengthNorm

public static int getInstanceNameLengthNorm()

Normal instanceName length is 30 characters

getInstanceNameLengthMax

public static int getInstanceNameLengthMax()

Maximum instanceName length is 255 characters

getInstanceNameDefaultValue

public static java.lang.String getInstanceNameDefaultValue()

Default value for instanceName. Returns ""

getInstanceNameInvalidValue

public static java.lang.String getInstanceNameInvalidValue()

Invalid value for instanceName. Returns "SANDEV_INVALID_INSTANCENAME"

getInstanceNamePrintValue

public java.lang.String getInstanceNamePrintValue()

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.

getInstanceNameFieldPrintValue

public java.lang.String getInstanceNameFieldPrintValue()

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

getInstanceNameRange

public java.lang.String getInstanceNameRange()

Return the range specification for this field

getInstanceNameValidityCheck

public java.lang.String getInstanceNameValidityCheck()

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.

getInstanceNameMetatype

public java.lang.String getInstanceNameMetatype()

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

getNodeStatus

public int getNodeStatus()

Accessor for nodeStatus

setNodeStatus

public void setNodeStatus(int nodeStatus)

Mutator for nodeStatus

nodeStatusValueToLabel

public java.lang.String nodeStatusValueToLabel(int val)

Given a value, return the declared label for it. This is a conversion method suitable for things like XML serialization where the value must be unique, descriptive, and readable, but is not subject to the same degree of transformation as a UI.

nodeStatusLabelToValue

public int nodeStatusLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

getNodeStatusPrintVals

public static java.lang.String[] getNodeStatusPrintVals()

Return an array of the possible values for this field in display format. These values can be used by a UI directly, or as keys for looking up localized text. These values are not guaranteed to be globally unique, another field with the same possible value may share the same string instance.

getNodeStatusKeyVals

public static java.lang.String[] getNodeStatusKeyVals()

Return an array of unique keys for the values of this field. These keys are globally unique and can be used for looking up localized text without any chance of the same key being used by any other field value in the application.

getNodeStatusActualVals

public static java.lang.String[] getNodeStatusActualVals()

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

nodeStatusPrint2Key

public static java.lang.String nodeStatusPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getNodeStatusPrintVals and getNodeStatusKeyVals methods for details.

nodeStatusPrint2Actual

public static java.lang.String nodeStatusPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getNodeStatusPrintVals and getNodeStatusActualVals methods for details.

nodeStatusActual2Print

public static java.lang.String nodeStatusActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getNodeStatusActualVals and getNodeStatusPrintVals methods for details.

getNodeStatusEnumSummary

public static java.lang.String getNodeStatusEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getNodeStatusFlag

public static boolean getNodeStatusFlag(int fieldflag)

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

getNodeStatusDefaultValue

public static int getNodeStatusDefaultValue()

Default value for nodeStatus. Returns NODESTATUS_UNDEFINED

getNodeStatusInvalidValue

public static int getNodeStatusInvalidValue()

Invalid value for nodeStatus. Returns UNDEFINED

getNodeStatusPrintValue

public java.lang.String getNodeStatusPrintValue()

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.

getNodeStatusFieldPrintValue

public java.lang.String getNodeStatusFieldPrintValue()

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

getNodeStatusRange

public java.lang.String getNodeStatusRange()

Return the range specification for this field

getNodeStatusValidityCheck

public java.lang.String getNodeStatusValidityCheck()

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.

getNodeStatusMetatype

public java.lang.String getNodeStatusMetatype()

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

getSandTransmitStatus

public int getSandTransmitStatus()

Accessor for sandTransmitStatus

Specified by:

getSandTransmitStatus in interface SandTransmitMessage

setSandTransmitStatus

public void setSandTransmitStatus(int sandTransmitStatus)

Mutator for sandTransmitStatus

Specified by:

setSandTransmitStatus in interface SandTransmitMessage

getSandTransmitStatusFlag

public static boolean getSandTransmitStatusFlag(int fieldflag)

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

getSandTransmitStatusDefaultValue

public static int getSandTransmitStatusDefaultValue()

Default value for sandTransmitStatus. Returns 0

getSandTransmitStatusInvalidValue

public static int getSandTransmitStatusInvalidValue()

Invalid value for sandTransmitStatus. Returns Integer.MIN_VALUE

getSandTransmitStatusPrintValue

public java.lang.String getSandTransmitStatusPrintValue()

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.

getSandTransmitStatusFieldPrintValue

public java.lang.String getSandTransmitStatusFieldPrintValue()

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

getSandTransmitStatusRange

public java.lang.String getSandTransmitStatusRange()

Return the range specification for this field

getSandTransmitStatusValidityCheck

public java.lang.String getSandTransmitStatusValidityCheck()

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.

getSandTransmitStatusMetatype

public java.lang.String getSandTransmitStatusMetatype()

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

getSandTransmitErrorMessage

public java.lang.String getSandTransmitErrorMessage()

Accessor for sandTransmitErrorMessage

Specified by:

getSandTransmitErrorMessage in interface SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)

Mutator for sandTransmitErrorMessage

Specified by:

setSandTransmitErrorMessage in interface SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)

Generic mutator for sandTransmitErrorMessage

getSandTransmitErrorMessageFlag

public static boolean getSandTransmitErrorMessageFlag(int fieldflag)

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

getSandTransmitErrorMessageLengthNorm

public static int getSandTransmitErrorMessageLengthNorm()

Normal sandTransmitErrorMessage length is 30 characters

getSandTransmitErrorMessageLengthMax

public static int getSandTransmitErrorMessageLengthMax()

Maximum sandTransmitErrorMessage length is 70 characters

getSandTransmitErrorMessageDefaultValue

public static java.lang.String getSandTransmitErrorMessageDefaultValue()

Default value for sandTransmitErrorMessage. Returns ""

getSandTransmitErrorMessageInvalidValue

public static java.lang.String getSandTransmitErrorMessageInvalidValue()

Invalid value for sandTransmitErrorMessage. Returns null

getSandTransmitErrorMessagePrintValue

public java.lang.String getSandTransmitErrorMessagePrintValue()

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.

getSandTransmitErrorMessageFieldPrintValue

public java.lang.String getSandTransmitErrorMessageFieldPrintValue()

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

getSandTransmitErrorMessageRange

public java.lang.String getSandTransmitErrorMessageRange()

Return the range specification for this field

getSandTransmitErrorMessageValidityCheck

public java.lang.String getSandTransmitErrorMessageValidityCheck()

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.

getSandTransmitErrorMessageMetatype

public java.lang.String getSandTransmitErrorMessageMetatype()

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

getSandTransmissionCount

public int getSandTransmissionCount()

Accessor for sandTransmissionCount

Specified by:

getSandTransmissionCount in interface SandTransmitMessage

setSandTransmissionCount

public void setSandTransmissionCount(int sandTransmissionCount)

Mutator for sandTransmissionCount

Specified by:

setSandTransmissionCount in interface SandTransmitMessage

getSandTransmissionCountFlag

public static boolean getSandTransmissionCountFlag(int fieldflag)

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

getSandTransmissionCountDefaultValue

public static int getSandTransmissionCountDefaultValue()

Default value for sandTransmissionCount. Returns 0

getSandTransmissionCountInvalidValue

public static int getSandTransmissionCountInvalidValue()

Invalid value for sandTransmissionCount. Returns Integer.MIN_VALUE

getSandTransmissionCountPrintValue

public java.lang.String getSandTransmissionCountPrintValue()

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.

getSandTransmissionCountFieldPrintValue

public java.lang.String getSandTransmissionCountFieldPrintValue()

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

getSandTransmissionCountRange

public java.lang.String getSandTransmissionCountRange()

Return the range specification for this field

getSandTransmissionCountValidityCheck

public java.lang.String getSandTransmissionCountValidityCheck()

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.

getSandTransmissionCountMetatype

public java.lang.String getSandTransmissionCountMetatype()

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

getSandTransmitAuthID

public long getSandTransmitAuthID()

Accessor for sandTransmitAuthID

Specified by:

getSandTransmitAuthID in interface SandTransmitMessage

setSandTransmitAuthID

public void setSandTransmitAuthID(long sandTransmitAuthID)

Mutator for sandTransmitAuthID

Specified by:

setSandTransmitAuthID in interface SandTransmitMessage

getSandTransmitAuthIDFlag

public static boolean getSandTransmitAuthIDFlag(int fieldflag)

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

getSandTransmitAuthIDDefaultValue

public static long getSandTransmitAuthIDDefaultValue()

Default value for sandTransmitAuthID. Returns 0

getSandTransmitAuthIDInvalidValue

public static long getSandTransmitAuthIDInvalidValue()

Invalid value for sandTransmitAuthID. Returns Long.MIN_VALUE

getSandTransmitAuthIDPrintValue

public java.lang.String getSandTransmitAuthIDPrintValue()

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.

getSandTransmitAuthIDFieldPrintValue

public java.lang.String getSandTransmitAuthIDFieldPrintValue()

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

getSandTransmitAuthIDRange

public java.lang.String getSandTransmitAuthIDRange()

Return the range specification for this field

getSandTransmitAuthIDValidityCheck

public java.lang.String getSandTransmitAuthIDValidityCheck()

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.

getSandTransmitAuthIDMetatype

public java.lang.String getSandTransmitAuthIDMetatype()

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 Ping 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 clonePing

Specified by:

cloneMessage in interface SandInstanceMessage

clonePing

public Ping clonePing()

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

copyDataFrom

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