org.sandev.TaskHeap.ExternalSync
Class ExternalSyncNodeInstance

java.lang.Object
  org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeDecl
      org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeInstance

All Implemented Interfaces:

org.sandev.basics.structs.NodeInstance, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage

public class ExternalSyncNodeInstance

extends ExternalSyncNodeDecl

implements org.sandev.basics.structs.NodeInstance, org.sandev.basics.util.Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeDecl
generator: org.sandev.generator.NodeInstClassGenerator
time: Dec 2, 2005 6:38:51 PM

This file contains all declared configuration and messaging parameters for this node.

Field Summary

protected org.sandev.basics.structs.NodeInstance[]	helperNodes Additional nodes instantiated with this node running together as a logical subsystem.
protected org.sandev.basics.sandmessages.IODeclReceive	incomingSyncExternalPlanSync Inbound org.sandev.TaskHeap.sandmessages.ExternalPlanSync synchronous messaging configuration
protected org.sandev.basics.sandmessages.IODeclReceive	incomingSyncPing Inbound org.sandev.basics.sandmessages.Ping synchronous messaging configuration
protected int	logLevel Calls to log with severity levels less than this value will be ignored.
static int	LOGLEVEL_DEBUG Possible value for logLevel
static int	LOGLEVEL_ERROR Possible value for logLevel
static int	LOGLEVEL_FATAL Possible value for logLevel
static int	LOGLEVEL_INFO Possible value for logLevel
static int	LOGLEVEL_WARN Possible value for logLevel
protected java.lang.String	nodeInstanceName The unique name identifying this specific node instance.
protected java.lang.String	servername The name of the server this instance will be running on.

Fields inherited from class org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeDecl

externalPlanFailure, externalPlanSuccess, httpAgentID

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

MSGMODE_DIRECT, MSGMODE_SECURE, MSGOPTIMIZE_IF_POSSIBLE, MSGOPTIMIZE_NEVER

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

ExternalSyncNodeInstance()
Default constructor calls init.

Method Summary

void	addHelperNodes(org.sandev.basics.structs.NodeInstance element) Appends a value to helperNodes
void	addHelperNodes(org.sandev.basics.structs.NodeInstance[] elements) Appends an array of values to helperNodes
void	clearHelperNodes() Clears all values from helperNodes
ExternalSyncNodeInstance	cloneExternalSyncNodeInstance() Make a deep copy of this ExternalSyncNodeInstance.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneExternalSyncNodeInstance
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(ExternalSyncNodeInstance other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.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
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.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.
org.sandev.basics.structs.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(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
java.lang.String	getExternalPlanFailure() Accessor for externalPlanFailure
static java.lang.String	getExternalPlanFailureDefaultValue() Default value for externalPlanFailure.
java.lang.String	getExternalPlanFailureFieldPrintValue() Return the print name of the externalPlanFailure field.
static boolean	getExternalPlanFailureFlag(int fieldflag) Field flag accessor.
static java.lang.String	getExternalPlanFailureInvalidValue() Invalid value for externalPlanFailure.
static int	getExternalPlanFailureLengthMax() Maximum externalPlanFailure length is 255 characters
static int	getExternalPlanFailureLengthNorm() Normal externalPlanFailure length is 60 characters
java.lang.String	getExternalPlanFailureMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getExternalPlanFailurePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getExternalPlanFailureRange() Return the range specification for this field
java.lang.String	getExternalPlanFailureValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getExternalPlanSuccess() Accessor for externalPlanSuccess
static java.lang.String	getExternalPlanSuccessDefaultValue() Default value for externalPlanSuccess.
java.lang.String	getExternalPlanSuccessFieldPrintValue() Return the print name of the externalPlanSuccess field.
static boolean	getExternalPlanSuccessFlag(int fieldflag) Field flag accessor.
static java.lang.String	getExternalPlanSuccessInvalidValue() Invalid value for externalPlanSuccess.
static int	getExternalPlanSuccessLengthMax() Maximum externalPlanSuccess length is 255 characters
static int	getExternalPlanSuccessLengthNorm() Normal externalPlanSuccess length is 60 characters
java.lang.String	getExternalPlanSuccessMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getExternalPlanSuccessPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getExternalPlanSuccessRange() Return the range specification for this field
java.lang.String	getExternalPlanSuccessValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.NodeInstance[]	getHelperNodes() Accessor for helperNodes
org.sandev.basics.structs.NodeInstance	getHelperNodes(int index) Returns the element at the specified index.
static org.sandev.basics.structs.NodeInstance[]	getHelperNodesDefaultValue() Default value for helperNodes.
static org.sandev.basics.structs.NodeInstance	getHelperNodesElementInvalidValue() Invalid value for helperNodeselement.
static boolean	getHelperNodesFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.structs.NodeInstance[]	getHelperNodesInvalidValue() Invalid value for helperNodes.
java.lang.String	getHelperNodesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getHelperNodesRange() Return the range specification for this field
java.lang.String	getHelperNodesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getHttpAgentID() Accessor for httpAgentID
static java.lang.String	getHttpAgentIDDefaultValue() Default value for httpAgentID.
java.lang.String	getHttpAgentIDFieldPrintValue() Return the print name of the httpAgentID field.
static boolean	getHttpAgentIDFlag(int fieldflag) Field flag accessor.
static java.lang.String	getHttpAgentIDInvalidValue() Invalid value for httpAgentID.
static int	getHttpAgentIDLengthMax() Maximum httpAgentID length is 80 characters
static int	getHttpAgentIDLengthNorm() Normal httpAgentID length is 30 characters
java.lang.String	getHttpAgentIDMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getHttpAgentIDPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getHttpAgentIDRange() Return the range specification for this field
java.lang.String	getHttpAgentIDValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncExternalPlanSync() Accessor for incomingSyncExternalPlanSync
static org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncExternalPlanSyncDefaultValue() Default value for incomingSyncExternalPlanSync.
java.lang.String	getIncomingSyncExternalPlanSyncFieldPrintValue() Return the print name of the incomingSyncExternalPlanSync field.
static boolean	getIncomingSyncExternalPlanSyncFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncExternalPlanSyncInvalidValue() Invalid value for incomingSyncExternalPlanSync.
java.lang.String	getIncomingSyncExternalPlanSyncMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getIncomingSyncExternalPlanSyncPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getIncomingSyncExternalPlanSyncRange() Return the range specification for this field
java.lang.String	getIncomingSyncExternalPlanSyncValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncPing() Accessor for incomingSyncPing
static org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncPingDefaultValue() Default value for incomingSyncPing.
java.lang.String	getIncomingSyncPingFieldPrintValue() Return the print name of the incomingSyncPing field.
static boolean	getIncomingSyncPingFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncPingInvalidValue() Invalid value for incomingSyncPing.
java.lang.String	getIncomingSyncPingMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getIncomingSyncPingPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getIncomingSyncPingRange() Return the range specification for this field
java.lang.String	getIncomingSyncPingValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getLogLevel() Accessor for logLevel
static java.lang.String[]	getLogLevelActualVals() Return an array of the possible values for this field as Strings.
static int	getLogLevelDefaultValue() Default value for logLevel.
static java.lang.String	getLogLevelEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getLogLevelFieldPrintValue() Return the print name of the logLevel field.
static boolean	getLogLevelFlag(int fieldflag) Field flag accessor.
static int	getLogLevelInvalidValue() Invalid value for logLevel.
static java.lang.String[]	getLogLevelKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getLogLevelMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getLogLevelPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getLogLevelPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLogLevelRange() Return the range specification for this field
java.lang.String	getLogLevelValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getNodeInstanceName() Accessor for nodeInstanceName
static java.lang.String	getNodeInstanceNameDefaultValue() Default value for nodeInstanceName.
java.lang.String	getNodeInstanceNameFieldPrintValue() Return the print name of the nodeInstanceName field.
static boolean	getNodeInstanceNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNodeInstanceNameInvalidValue() Invalid value for nodeInstanceName.
static int	getNodeInstanceNameLengthMax() Maximum nodeInstanceName length is 70 characters
static int	getNodeInstanceNameLengthNorm() Normal nodeInstanceName length is 30 characters
java.lang.String	getNodeInstanceNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNodeInstanceNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNodeInstanceNameRange() Return the range specification for this field
java.lang.String	getNodeInstanceNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getServername() Accessor for servername
static java.lang.String	getServernameDefaultValue() Default value for servername.
java.lang.String	getServernameFieldPrintValue() Return the print name of the servername field.
static boolean	getServernameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getServernameInvalidValue() Invalid value for servername.
static int	getServernameLengthMax() Maximum servername length is 70 characters
static int	getServernameLengthNorm() Normal servername length is 30 characters
java.lang.String	getServernameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getServernamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getServernameRange() Return the range specification for this field
java.lang.String	getServernameValidityCheck() 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.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new ExternalSyncNodeInstance instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
boolean	helperNodesContains(org.sandev.basics.structs.NodeInstance val) Returns true if helperNodes contains the specified value.
int	helperNodesIndexOf(org.sandev.basics.structs.NodeInstance val) Return the index of the specified value in helperNodes, or -1 if not found.
void	init() Initialize all fields to their default values
void	insertHelperNodes(int index, org.sandev.basics.structs.NodeInstance value) Insert the specified element at the specified index.
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
static java.lang.String	logLevelActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	logLevelLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	logLevelPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	logLevelPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	logLevelValueToLabel(int val) Given a value, return the declared label for it.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
org.sandev.basics.structs.NodeInstance	removeHelperNodes(int index) Remove the element at the specified index and return it.
boolean	removeHelperNodesValue(org.sandev.basics.structs.NodeInstance value) Removes the given element from helperNodes.
org.sandev.basics.sandmessages.ServerDeclaration	resolveServernameReference(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
org.sandev.basics.sandmessages.ServerDeclaration	resolveServernameReferenceNonCrit(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance with all default values instead.
void	setExternalPlanFailure(java.lang.Object externalPlanFailure) Generic mutator for externalPlanFailure
void	setExternalPlanFailure(java.lang.String externalPlanFailure) Mutator for externalPlanFailure
void	setExternalPlanSuccess(java.lang.Object externalPlanSuccess) Generic mutator for externalPlanSuccess
void	setExternalPlanSuccess(java.lang.String externalPlanSuccess) Mutator for externalPlanSuccess
void	setHelperNodes(int index, org.sandev.basics.structs.NodeInstance value) Set the value at the index specified.
void	setHelperNodes(org.sandev.basics.structs.NodeInstance[] helperNodes) Mutator for helperNodes
void	setHelperNodes(java.lang.Object[] helperNodes) Generic mutator for helperNodes
void	setHttpAgentID(java.lang.Object httpAgentID) Generic mutator for httpAgentID
void	setHttpAgentID(java.lang.String httpAgentID) Mutator for httpAgentID
void	setIncomingSyncExternalPlanSync(org.sandev.basics.sandmessages.IODeclReceive incomingSyncExternalPlanSync) Mutator for incomingSyncExternalPlanSync
void	setIncomingSyncExternalPlanSync(java.lang.Object incomingSyncExternalPlanSync) Generic mutator for incomingSyncExternalPlanSync
void	setIncomingSyncPing(org.sandev.basics.sandmessages.IODeclReceive incomingSyncPing) Mutator for incomingSyncPing
void	setIncomingSyncPing(java.lang.Object incomingSyncPing) Generic mutator for incomingSyncPing
void	setLogLevel(int logLevel) Mutator for logLevel
void	setNodeInstanceName(java.lang.Object nodeInstanceName) Generic mutator for nodeInstanceName
void	setNodeInstanceName(java.lang.String nodeInstanceName) Mutator for nodeInstanceName
void	setServername(java.lang.Object servername) Generic mutator for servername
void	setServername(java.lang.String servername) Mutator for servername
int	sizeofHelperNodes() Returns the size of helperNodes.
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

nodeInstanceName

protected java.lang.String nodeInstanceName

The unique name identifying this specific node instance.

servername

protected java.lang.String servername

The name of the server this instance will be running on.

helperNodes

protected org.sandev.basics.structs.NodeInstance[] helperNodes

Additional nodes instantiated with this node running together as a logical subsystem.

incomingSyncPing

protected org.sandev.basics.sandmessages.IODeclReceive incomingSyncPing

Inbound org.sandev.basics.sandmessages.Ping synchronous messaging configuration

incomingSyncExternalPlanSync

protected org.sandev.basics.sandmessages.IODeclReceive incomingSyncExternalPlanSync

Inbound org.sandev.TaskHeap.sandmessages.ExternalPlanSync synchronous messaging configuration

logLevel

protected int logLevel

Calls to log with severity levels less than this value will be ignored. For example, if you set this field to LOGLEVEL_WARN, then a call to log with LOGLEVEL_INFO will be ignored, while any call with LOGLEVEL_WARN/ERROR/FATAL will be processed. The log levels are defined in org.sandev.basics.nodecommon.Logger

LOGLEVEL_DEBUG

public static final int LOGLEVEL_DEBUG

Possible value for logLevel

See Also:

Constant Field Values

LOGLEVEL_INFO

public static final int LOGLEVEL_INFO

Possible value for logLevel

See Also:

Constant Field Values

LOGLEVEL_WARN

public static final int LOGLEVEL_WARN

Possible value for logLevel

See Also:

Constant Field Values

LOGLEVEL_ERROR

public static final int LOGLEVEL_ERROR

Possible value for logLevel

See Also:

Constant Field Values

LOGLEVEL_FATAL

public static final int LOGLEVEL_FATAL

Possible value for logLevel

See Also:

Constant Field Values

Constructor Detail

ExternalSyncNodeInstance

public ExternalSyncNodeInstance()

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 org.sandev.basics.structs.SandInstanceMessage

getExternalPlanSuccess

public java.lang.String getExternalPlanSuccess()

Accessor for externalPlanSuccess

setExternalPlanSuccess

public void setExternalPlanSuccess(java.lang.String externalPlanSuccess)

Mutator for externalPlanSuccess

setExternalPlanSuccess

public void setExternalPlanSuccess(java.lang.Object externalPlanSuccess)

Generic mutator for externalPlanSuccess

getExternalPlanSuccessFlag

public static boolean getExternalPlanSuccessFlag(int fieldflag)

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

getExternalPlanSuccessLengthNorm

public static int getExternalPlanSuccessLengthNorm()

Normal externalPlanSuccess length is 60 characters

getExternalPlanSuccessLengthMax

public static int getExternalPlanSuccessLengthMax()

Maximum externalPlanSuccess length is 255 characters

getExternalPlanSuccessDefaultValue

public static java.lang.String getExternalPlanSuccessDefaultValue()

Default value for externalPlanSuccess. Returns "Information retrieved successfully."

getExternalPlanSuccessInvalidValue

public static java.lang.String getExternalPlanSuccessInvalidValue()

Invalid value for externalPlanSuccess. Returns null

getExternalPlanSuccessPrintValue

public java.lang.String getExternalPlanSuccessPrintValue()

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.

getExternalPlanSuccessFieldPrintValue

public java.lang.String getExternalPlanSuccessFieldPrintValue()

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

getExternalPlanSuccessRange

public java.lang.String getExternalPlanSuccessRange()

Return the range specification for this field

getExternalPlanSuccessValidityCheck

public java.lang.String getExternalPlanSuccessValidityCheck()

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.

getExternalPlanSuccessMetatype

public java.lang.String getExternalPlanSuccessMetatype()

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

getExternalPlanFailure

public java.lang.String getExternalPlanFailure()

Accessor for externalPlanFailure

setExternalPlanFailure

public void setExternalPlanFailure(java.lang.String externalPlanFailure)

Mutator for externalPlanFailure

setExternalPlanFailure

public void setExternalPlanFailure(java.lang.Object externalPlanFailure)

Generic mutator for externalPlanFailure

getExternalPlanFailureFlag

public static boolean getExternalPlanFailureFlag(int fieldflag)

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

getExternalPlanFailureLengthNorm

public static int getExternalPlanFailureLengthNorm()

Normal externalPlanFailure length is 60 characters

getExternalPlanFailureLengthMax

public static int getExternalPlanFailureLengthMax()

Maximum externalPlanFailure length is 255 characters

getExternalPlanFailureDefaultValue

public static java.lang.String getExternalPlanFailureDefaultValue()

Default value for externalPlanFailure. Returns "Information retrieval failed: $ERROR"

getExternalPlanFailureInvalidValue

public static java.lang.String getExternalPlanFailureInvalidValue()

Invalid value for externalPlanFailure. Returns null

getExternalPlanFailurePrintValue

public java.lang.String getExternalPlanFailurePrintValue()

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.

getExternalPlanFailureFieldPrintValue

public java.lang.String getExternalPlanFailureFieldPrintValue()

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

getExternalPlanFailureRange

public java.lang.String getExternalPlanFailureRange()

Return the range specification for this field

getExternalPlanFailureValidityCheck

public java.lang.String getExternalPlanFailureValidityCheck()

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.

getExternalPlanFailureMetatype

public java.lang.String getExternalPlanFailureMetatype()

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

getHttpAgentID

public java.lang.String getHttpAgentID()

Accessor for httpAgentID

setHttpAgentID

public void setHttpAgentID(java.lang.String httpAgentID)

Mutator for httpAgentID

setHttpAgentID

public void setHttpAgentID(java.lang.Object httpAgentID)

Generic mutator for httpAgentID

getHttpAgentIDFlag

public static boolean getHttpAgentIDFlag(int fieldflag)

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

getHttpAgentIDLengthNorm

public static int getHttpAgentIDLengthNorm()

Normal httpAgentID length is 30 characters

getHttpAgentIDLengthMax

public static int getHttpAgentIDLengthMax()

Maximum httpAgentID length is 80 characters

getHttpAgentIDDefaultValue

public static java.lang.String getHttpAgentIDDefaultValue()

Default value for httpAgentID. Returns "$PRE ExternalSyncNode"

getHttpAgentIDInvalidValue

public static java.lang.String getHttpAgentIDInvalidValue()

Invalid value for httpAgentID. Returns null

getHttpAgentIDPrintValue

public java.lang.String getHttpAgentIDPrintValue()

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.

getHttpAgentIDFieldPrintValue

public java.lang.String getHttpAgentIDFieldPrintValue()

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

getHttpAgentIDRange

public java.lang.String getHttpAgentIDRange()

Return the range specification for this field

getHttpAgentIDValidityCheck

public java.lang.String getHttpAgentIDValidityCheck()

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.

getHttpAgentIDMetatype

public java.lang.String getHttpAgentIDMetatype()

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

getNodeInstanceName

public java.lang.String getNodeInstanceName()

Accessor for nodeInstanceName

Specified by:

getNodeInstanceName in interface org.sandev.basics.structs.NodeInstance

setNodeInstanceName

public void setNodeInstanceName(java.lang.String nodeInstanceName)

Mutator for nodeInstanceName

setNodeInstanceName

public void setNodeInstanceName(java.lang.Object nodeInstanceName)

Generic mutator for nodeInstanceName

getNodeInstanceNameFlag

public static boolean getNodeInstanceNameFlag(int fieldflag)

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

getNodeInstanceNameLengthNorm

public static int getNodeInstanceNameLengthNorm()

Normal nodeInstanceName length is 30 characters

getNodeInstanceNameLengthMax

public static int getNodeInstanceNameLengthMax()

Maximum nodeInstanceName length is 70 characters

getNodeInstanceNameDefaultValue

public static java.lang.String getNodeInstanceNameDefaultValue()

Default value for nodeInstanceName. Returns ""

getNodeInstanceNameInvalidValue

public static java.lang.String getNodeInstanceNameInvalidValue()

Invalid value for nodeInstanceName. Returns null

getNodeInstanceNamePrintValue

public java.lang.String getNodeInstanceNamePrintValue()

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.

getNodeInstanceNameFieldPrintValue

public java.lang.String getNodeInstanceNameFieldPrintValue()

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

getNodeInstanceNameRange

public java.lang.String getNodeInstanceNameRange()

Return the range specification for this field

getNodeInstanceNameValidityCheck

public java.lang.String getNodeInstanceNameValidityCheck()

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.

getNodeInstanceNameMetatype

public java.lang.String getNodeInstanceNameMetatype()

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

getServername

public java.lang.String getServername()

Accessor for servername

Specified by:

getServername in interface org.sandev.basics.structs.NodeInstance

setServername

public void setServername(java.lang.String servername)

Mutator for servername

Specified by:

setServername in interface org.sandev.basics.structs.NodeInstance

setServername

public void setServername(java.lang.Object servername)

Generic mutator for servername

getServernameFlag

public static boolean getServernameFlag(int fieldflag)

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

getServernameLengthNorm

public static int getServernameLengthNorm()

Normal servername length is 30 characters

getServernameLengthMax

public static int getServernameLengthMax()

Maximum servername length is 70 characters

getServernameDefaultValue

public static java.lang.String getServernameDefaultValue()

Default value for servername. Returns ""

getServernameInvalidValue

public static java.lang.String getServernameInvalidValue()

Invalid value for servername. Returns null

getServernamePrintValue

public java.lang.String getServernamePrintValue()

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.

getServernameFieldPrintValue

public java.lang.String getServernameFieldPrintValue()

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

getServernameRange

public java.lang.String getServernameRange()

Return the range specification for this field

resolveServernameReferenceNonCrit

public org.sandev.basics.sandmessages.ServerDeclaration resolveServernameReferenceNonCrit(org.sandev.basics.util.NameLookup lookup,
                                                                                          org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning a new instance with all default values instead. This is to support the UI, which is calling to get detail for a richer display. If the detail is not available, it's not critical.

resolveServernameReference

public org.sandev.basics.sandmessages.ServerDeclaration resolveServernameReference(org.sandev.basics.util.NameLookup lookup,
                                                                                   org.sandev.basics.util.AuthUser au)
                                                                            throws org.sandev.basics.structs.SandException

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getServernameValidityCheck

public java.lang.String getServernameValidityCheck()

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.

getServernameMetatype

public java.lang.String getServernameMetatype()

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

getHelperNodes

public org.sandev.basics.structs.NodeInstance[] getHelperNodes()

Accessor for helperNodes

Specified by:

getHelperNodes in interface org.sandev.basics.structs.NodeInstance

setHelperNodes

public void setHelperNodes(org.sandev.basics.structs.NodeInstance[] helperNodes)

Mutator for helperNodes

Specified by:

setHelperNodes in interface org.sandev.basics.structs.NodeInstance

setHelperNodes

public void setHelperNodes(java.lang.Object[] helperNodes)

Generic mutator for helperNodes

addHelperNodes

public void addHelperNodes(org.sandev.basics.structs.NodeInstance element)

Appends a value to helperNodes

addHelperNodes

public void addHelperNodes(org.sandev.basics.structs.NodeInstance[] elements)

Appends an array of values to helperNodes

getHelperNodes

public org.sandev.basics.structs.NodeInstance getHelperNodes(int index)

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

setHelperNodes

public void setHelperNodes(int index,
                           org.sandev.basics.structs.NodeInstance value)

Set the value at the index specified.

insertHelperNodes

public void insertHelperNodes(int index,
                              org.sandev.basics.structs.NodeInstance 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.

removeHelperNodes

public org.sandev.basics.structs.NodeInstance removeHelperNodes(int index)

Remove the element at the specified index and return it.

removeHelperNodesValue

public boolean removeHelperNodesValue(org.sandev.basics.structs.NodeInstance value)

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

clearHelperNodes

public void clearHelperNodes()

Clears all values from helperNodes

helperNodesContains

public boolean helperNodesContains(org.sandev.basics.structs.NodeInstance val)

Returns true if helperNodes contains the specified value.

helperNodesIndexOf

public int helperNodesIndexOf(org.sandev.basics.structs.NodeInstance val)

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

sizeofHelperNodes

public int sizeofHelperNodes()

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

getHelperNodesFlag

public static boolean getHelperNodesFlag(int fieldflag)

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

getHelperNodesDefaultValue

public static org.sandev.basics.structs.NodeInstance[] getHelperNodesDefaultValue()

Default value for helperNodes. Returns new org.sandev.basics.structs.NodeInstance[0]

getHelperNodesElementInvalidValue

public static org.sandev.basics.structs.NodeInstance getHelperNodesElementInvalidValue()

Invalid value for helperNodeselement. Returns null

getHelperNodesInvalidValue

public static org.sandev.basics.structs.NodeInstance[] getHelperNodesInvalidValue()

Invalid value for helperNodes. Returns null

getHelperNodesRange

public java.lang.String getHelperNodesRange()

Return the range specification for this field

getHelperNodesValidityCheck

public java.lang.String getHelperNodesValidityCheck()

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.

getHelperNodesMetatype

public java.lang.String getHelperNodesMetatype()

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

getIncomingSyncPing

public org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncPing()

Accessor for incomingSyncPing

setIncomingSyncPing

public void setIncomingSyncPing(org.sandev.basics.sandmessages.IODeclReceive incomingSyncPing)

Mutator for incomingSyncPing

setIncomingSyncPing

public void setIncomingSyncPing(java.lang.Object incomingSyncPing)

Generic mutator for incomingSyncPing

getIncomingSyncPingFlag

public static boolean getIncomingSyncPingFlag(int fieldflag)

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

getIncomingSyncPingDefaultValue

public static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncPingDefaultValue()

Default value for incomingSyncPing. Returns new IODeclReceive()

getIncomingSyncPingInvalidValue

public static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncPingInvalidValue()

Invalid value for incomingSyncPing. Returns null

getIncomingSyncPingPrintValue

public java.lang.String getIncomingSyncPingPrintValue()

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.

getIncomingSyncPingFieldPrintValue

public java.lang.String getIncomingSyncPingFieldPrintValue()

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

getIncomingSyncPingRange

public java.lang.String getIncomingSyncPingRange()

Return the range specification for this field

getIncomingSyncPingValidityCheck

public java.lang.String getIncomingSyncPingValidityCheck()

Return the empty string if the value of this field is valid