Configuration

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sandev.basics.sandmessages
Class Configuration

java.lang.Object
  org.sandev.basics.structs.ConfigurationStruct
      org.sandev.basics.sandmessages.Configuration

All Implemented Interfaces:: Resolvable, SandInstanceMessage, SandMessage, SandStructMessage, SandTransmitMessage

public class Configuration
extends ConfigurationStruct
implements SandStructMessage, Resolvable, SandTransmitMessage

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

Field Summary
`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.ConfigurationStruct

description, globalParams, initialData, loggerClass, messagerClass, name, nodes, servers

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
`Configuration()` Default constructor calls init.

Method Summary
`void`	`addGlobalParams(SandAttrVal element)` Appends a value to globalParams
`void`	`addGlobalParams(SandAttrVal[] elements)` Appends an array of values to globalParams
`void`	`addInitialData(SandPersistMessage element)` Appends a value to initialData
`void`	`addInitialData(SandPersistMessage[] elements)` Appends an array of values to initialData
`void`	`addNodes(NodeInstance element)` Appends a value to nodes
`void`	`addNodes(NodeInstance[] elements)` Appends an array of values to nodes
`void`	`addServers(ServerDeclaration element)` Appends a value to servers
`void`	`addServers(ServerDeclaration[] elements)` Appends an array of values to servers
`void`	`clearGlobalParams()` Clears all values from globalParams
`void`	`clearInitialData()` Clears all values from initialData
`void`	`clearNodes()` Clears all values from nodes
`void`	`clearServers()` Clears all values from servers
`Configuration`	`cloneConfiguration()` Make a deep copy of this Configuration.
`SandInstanceMessage`	`cloneMessage()` Calls cloneConfiguration
`SandInstanceMessage`	`convertToSuperstructClass()` Return a new instance of the message associated with the superstruct of this instance.
`void`	`copyDataFrom(Configuration 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`	`getDescription()` Accessor for description
`static java.lang.String`	`getDescriptionDefaultValue()` Default value for description.
`java.lang.String`	`getDescriptionFieldPrintValue()` Return the print name of the description field.
`static boolean`	`getDescriptionFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getDescriptionInvalidValue()` Invalid value for description.
`static int`	`getDescriptionLengthMax()` Maximum description length is 4096 characters
`static int`	`getDescriptionLengthNorm()` Normal description length is 255 characters
`java.lang.String`	`getDescriptionMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getDescriptionPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getDescriptionRange()` Return the range specification for this field
`java.lang.String`	`getDescriptionValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`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.
`SandAttrVal[]`	`getGlobalParams()` Accessor for globalParams
`SandAttrVal`	`getGlobalParams(int index)` Returns the element at the specified index.
`static SandAttrVal[]`	`getGlobalParamsDefaultValue()` Default value for globalParams.
`static SandAttrVal`	`getGlobalParamsElementInvalidValue()` Invalid value for globalParamselement.
`static boolean`	`getGlobalParamsFlag(int fieldflag)` Field flag accessor.
`static SandAttrVal[]`	`getGlobalParamsInvalidValue()` Invalid value for globalParams.
`static int`	`getGlobalParamsLengthMax()` Maximum globalParams length is 8192 characters
`static int`	`getGlobalParamsLengthNorm()` Normal globalParams length is 255 characters
`java.lang.String`	`getGlobalParamsMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getGlobalParamsRange()` Return the range specification for this field
`java.lang.String`	`getGlobalParamsValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`SandPersistMessage[]`	`getInitialData()` Accessor for initialData
`SandPersistMessage`	`getInitialData(int index)` Returns the element at the specified index.
`static SandPersistMessage[]`	`getInitialDataDefaultValue()` Default value for initialData.
`static SandPersistMessage`	`getInitialDataElementInvalidValue()` Invalid value for initialDataelement.
`static boolean`	`getInitialDataFlag(int fieldflag)` Field flag accessor.
`static SandPersistMessage[]`	`getInitialDataInvalidValue()` Invalid value for initialData.
`java.lang.String`	`getInitialDataMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getInitialDataRange()` Return the range specification for this field
`java.lang.String`	`getInitialDataValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getLoggerClass()` Accessor for loggerClass
`static java.lang.String`	`getLoggerClassDefaultValue()` Default value for loggerClass.
`java.lang.String`	`getLoggerClassFieldPrintValue()` Return the print name of the loggerClass field.
`static boolean`	`getLoggerClassFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getLoggerClassInvalidValue()` Invalid value for loggerClass.
`static int`	`getLoggerClassLengthMax()` Maximum loggerClass length is 80 characters
`static int`	`getLoggerClassLengthNorm()` Normal loggerClass length is 60 characters
`java.lang.String`	`getLoggerClassMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLoggerClassPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLoggerClassRange()` Return the range specification for this field
`java.lang.String`	`getLoggerClassValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getMessagerClass()` Accessor for messagerClass
`static java.lang.String`	`getMessagerClassDefaultValue()` Default value for messagerClass.
`java.lang.String`	`getMessagerClassFieldPrintValue()` Return the print name of the messagerClass field.
`static boolean`	`getMessagerClassFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getMessagerClassInvalidValue()` Invalid value for messagerClass.
`static int`	`getMessagerClassLengthMax()` Maximum messagerClass length is 80 characters
`static int`	`getMessagerClassLengthNorm()` Normal messagerClass length is 60 characters
`java.lang.String`	`getMessagerClassMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getMessagerClassPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getMessagerClassRange()` Return the range specification for this field
`java.lang.String`	`getMessagerClassValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getName()` Accessor for name
`static java.lang.String`	`getNameDefaultValue()` Default value for name.
`java.lang.String`	`getNameFieldPrintValue()` Return the print name of the name field.
`static boolean`	`getNameFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getNameInvalidValue()` Invalid value for name.
`static int`	`getNameLengthMax()` Maximum name length is 128 characters
`static int`	`getNameLengthNorm()` Normal name length is 30 characters
`java.lang.String`	`getNameMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNamePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNameRange()` Return the range specification for this field
`java.lang.String`	`getNameValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`NodeInstance[]`	`getNodes()` Accessor for nodes
`NodeInstance`	`getNodes(int index)` Returns the element at the specified index.
`static NodeInstance[]`	`getNodesDefaultValue()` Default value for nodes.
`static NodeInstance`	`getNodesElementInvalidValue()` Invalid value for nodeselement.
`static boolean`	`getNodesFlag(int fieldflag)` Field flag accessor.
`static NodeInstance[]`	`getNodesInvalidValue()` Invalid value for nodes.
`java.lang.String`	`getNodesMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNodesRange()` Return the range specification for this field
`java.lang.String`	`getNodesValidityCheck()` 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.
`ServerDeclaration[]`	`getServers()` Accessor for servers
`ServerDeclaration`	`getServers(int index)` Returns the element at the specified index.
`static ServerDeclaration[]`	`getServersDefaultValue()` Default value for servers.
`static ServerDeclaration`	`getServersElementInvalidValue()` Invalid value for serverselement.
`static boolean`	`getServersFlag(int fieldflag)` Field flag accessor.
`static ServerDeclaration[]`	`getServersInvalidValue()` Invalid value for servers.
`java.lang.String`	`getServersMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getServersRange()` Return the range specification for this field
`java.lang.String`	`getServersValidityCheck()` 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 Configuration instance
`SandUpdateMessage`	`getUpdateMessage()` Returns a new ConfigurationUpdate instance
`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.
`boolean`	`globalParamsContains(SandAttrVal val)` Returns true if globalParams contains the specified value.
`int`	`globalParamsIndexOf(SandAttrVal val)` Return the index of the specified value in globalParams, or -1 if not found.
`void`	`init()` Initialize all fields to their default values
`boolean`	`initialDataContains(SandPersistMessage val)` Returns true if initialData contains the specified value.
`int`	`initialDataIndexOf(SandPersistMessage val)` Return the index of the specified value in initialData, or -1 if not found.
`void`	`insertGlobalParams(int index, SandAttrVal value)` Insert the specified element at the specified index.
`void`	`insertInitialData(int index, SandPersistMessage value)` Insert the specified element at the specified index.
`void`	`insertNodes(int index, NodeInstance value)` Insert the specified element at the specified index.
`void`	`insertServers(int index, ServerDeclaration value)` Insert the specified element at the specified index.
`boolean`	`isEquivalent(SandMessage sm)` Declared field equivalence check as specified by the SandMessage interface.
`boolean`	`nodesContains(NodeInstance val)` Returns true if nodes contains the specified value.
`int`	`nodesIndexOf(NodeInstance val)` Return the index of the specified value in nodes, or -1 if not found.
`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.
`SandAttrVal`	`removeGlobalParams(int index)` Remove the element at the specified index and return it.
`boolean`	`removeGlobalParamsValue(SandAttrVal value)` Removes the given element from globalParams.
`SandPersistMessage`	`removeInitialData(int index)` Remove the element at the specified index and return it.
`boolean`	`removeInitialDataValue(SandPersistMessage value)` Removes the given element from initialData.
`NodeInstance`	`removeNodes(int index)` Remove the element at the specified index and return it.
`boolean`	`removeNodesValue(NodeInstance value)` Removes the given element from nodes.
`ServerDeclaration`	`removeServers(int index)` Remove the element at the specified index and return it.
`boolean`	`removeServersValue(ServerDeclaration value)` Removes the given element from servers.
`boolean`	`serversContains(ServerDeclaration val)` Returns true if servers contains the specified value.
`int`	`serversIndexOf(ServerDeclaration val)` Return the index of the specified value in servers, or -1 if not found.
`void`	`setDescription(java.lang.Object description)` Generic mutator for description
`void`	`setDescription(java.lang.String description)` Mutator for description
`void`	`setGlobalParams(int index, SandAttrVal value)` Set the value at the index specified.
`void`	`setGlobalParams(java.lang.Object[] globalParams)` Generic mutator for globalParams
`void`	`setGlobalParams(SandAttrVal[] globalParams)` Mutator for globalParams
`void`	`setInitialData(int index, SandPersistMessage value)` Set the value at the index specified.
`void`	`setInitialData(java.lang.Object[] initialData)` Generic mutator for initialData
`void`	`setInitialData(SandPersistMessage[] initialData)` Mutator for initialData
`void`	`setLoggerClass(java.lang.Object loggerClass)` Generic mutator for loggerClass
`void`	`setLoggerClass(java.lang.String loggerClass)` Mutator for loggerClass
`void`	`setMessagerClass(java.lang.Object messagerClass)` Generic mutator for messagerClass
`void`	`setMessagerClass(java.lang.String messagerClass)` Mutator for messagerClass
`void`	`setName(java.lang.Object name)` Generic mutator for name
`void`	`setName(java.lang.String name)` Mutator for name
`void`	`setNodes(int index, NodeInstance value)` Set the value at the index specified.
`void`	`setNodes(NodeInstance[] nodes)` Mutator for nodes
`void`	`setNodes(java.lang.Object[] nodes)` Generic mutator for nodes
`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
`void`	`setServers(int index, ServerDeclaration value)` Set the value at the index specified.
`void`	`setServers(java.lang.Object[] servers)` Generic mutator for servers
`void`	`setServers(ServerDeclaration[] servers)` Mutator for servers
`int`	`sizeofGlobalParams()` Returns the size of globalParams.
`int`	`sizeofInitialData()` Returns the size of initialData.
`int`	`sizeofNodes()` Returns the size of nodes.
`int`	`sizeofServers()` Returns the size of servers.
`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

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

Configuration

public Configuration()

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

getName

public java.lang.String getName()

Accessor for name

setName

public void setName(java.lang.String name)

Mutator for name

setName

public void setName(java.lang.Object name)

Generic mutator for name

getNameFlag

public static boolean getNameFlag(int fieldflag)

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

getNameLengthNorm

public static int getNameLengthNorm()

Normal name length is 30 characters

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 128 characters

getNameDefaultValue

public static java.lang.String getNameDefaultValue()

Default value for name. Returns "default"

getNameInvalidValue

public static java.lang.String getNameInvalidValue()

Invalid value for name. Returns "SANDEV_INVALID_NAME"

getNamePrintValue

public java.lang.String getNamePrintValue()

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.

getNameFieldPrintValue

public java.lang.String getNameFieldPrintValue()

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

getNameRange

public java.lang.String getNameRange()

Return the range specification for this field

getNameValidityCheck

public java.lang.String getNameValidityCheck()

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.

getNameMetatype

public java.lang.String getNameMetatype()

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

getDescription

public java.lang.String getDescription()

Accessor for description

setDescription

public void setDescription(java.lang.String description)

Mutator for description

setDescription

public void setDescription(java.lang.Object description)

Generic mutator for description

getDescriptionFlag

public static boolean getDescriptionFlag(int fieldflag)

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

getDescriptionLengthNorm

public static int getDescriptionLengthNorm()

Normal description length is 255 characters

getDescriptionLengthMax

public static int getDescriptionLengthMax()

Maximum description length is 4096 characters

getDescriptionDefaultValue

public static java.lang.String getDescriptionDefaultValue()

Default value for description. Returns ""

getDescriptionInvalidValue

public static java.lang.String getDescriptionInvalidValue()

Invalid value for description. Returns "SANDEV_INVALID_DESCRIPTION"

getDescriptionPrintValue

public java.lang.String getDescriptionPrintValue()

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

getDescriptionFieldPrintValue

public java.lang.String getDescriptionFieldPrintValue()

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

getDescriptionRange

public java.lang.String getDescriptionRange()

Return the range specification for this field

getDescriptionValidityCheck

public java.lang.String getDescriptionValidityCheck()

getDescriptionMetatype

public java.lang.String getDescriptionMetatype()

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

getLoggerClass

public java.lang.String getLoggerClass()

Accessor for loggerClass

setLoggerClass

public void setLoggerClass(java.lang.String loggerClass)

Mutator for loggerClass

setLoggerClass

public void setLoggerClass(java.lang.Object loggerClass)

Generic mutator for loggerClass

getLoggerClassFlag

public static boolean getLoggerClassFlag(int fieldflag)

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

getLoggerClassLengthNorm

public static int getLoggerClassLengthNorm()

Normal loggerClass length is 60 characters

getLoggerClassLengthMax

public static int getLoggerClassLengthMax()

Maximum loggerClass length is 80 characters

getLoggerClassDefaultValue

public static java.lang.String getLoggerClassDefaultValue()

Default value for loggerClass. Returns "org.sandev.tools.util.SandLogger"

getLoggerClassInvalidValue

public static java.lang.String getLoggerClassInvalidValue()

Invalid value for loggerClass. Returns "SANDEV_INVALID_LOGGER_CLASS"

getLoggerClassPrintValue

public java.lang.String getLoggerClassPrintValue()

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

getLoggerClassFieldPrintValue

public java.lang.String getLoggerClassFieldPrintValue()

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

getLoggerClassRange

public java.lang.String getLoggerClassRange()

Return the range specification for this field

getLoggerClassValidityCheck

public java.lang.String getLoggerClassValidityCheck()

getLoggerClassMetatype

public java.lang.String getLoggerClassMetatype()

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

getMessagerClass

public java.lang.String getMessagerClass()

Accessor for messagerClass

setMessagerClass

public void setMessagerClass(java.lang.String messagerClass)

Mutator for messagerClass

setMessagerClass

public void setMessagerClass(java.lang.Object messagerClass)

Generic mutator for messagerClass

getMessagerClassFlag

public static boolean getMessagerClassFlag(int fieldflag)

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

getMessagerClassLengthNorm

public static int getMessagerClassLengthNorm()

Normal messagerClass length is 60 characters

getMessagerClassLengthMax

public static int getMessagerClassLengthMax()

Maximum messagerClass length is 80 characters

getMessagerClassDefaultValue

public static java.lang.String getMessagerClassDefaultValue()

Default value for messagerClass. Returns "org.sandev.tools.util.DirectCallMessager"

getMessagerClassInvalidValue

public static java.lang.String getMessagerClassInvalidValue()

Invalid value for messagerClass. Returns "SANDEV_INVALID_MESSAGER_CLASS"

getMessagerClassPrintValue

public java.lang.String getMessagerClassPrintValue()

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

getMessagerClassFieldPrintValue

public java.lang.String getMessagerClassFieldPrintValue()

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

getMessagerClassRange

public java.lang.String getMessagerClassRange()

Return the range specification for this field

getMessagerClassValidityCheck

public java.lang.String getMessagerClassValidityCheck()

getMessagerClassMetatype

public java.lang.String getMessagerClassMetatype()

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

getGlobalParams

public SandAttrVal[] getGlobalParams()

Accessor for globalParams

setGlobalParams

public void setGlobalParams(SandAttrVal[] globalParams)

Mutator for globalParams

setGlobalParams

public void setGlobalParams(java.lang.Object[] globalParams)

Generic mutator for globalParams

addGlobalParams

public void addGlobalParams(SandAttrVal element)

Appends a value to globalParams

addGlobalParams

public void addGlobalParams(SandAttrVal[] elements)

Appends an array of values to globalParams

getGlobalParams

public SandAttrVal getGlobalParams(int index)

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

setGlobalParams

public void setGlobalParams(int index,
                            SandAttrVal value)

Set the value at the index specified.

insertGlobalParams

public void insertGlobalParams(int index,
                               SandAttrVal 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.

removeGlobalParams

public SandAttrVal removeGlobalParams(int index)

Remove the element at the specified index and return it.

removeGlobalParamsValue

public boolean removeGlobalParamsValue(SandAttrVal value)

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

clearGlobalParams

public void clearGlobalParams()

Clears all values from globalParams

globalParamsContains

public boolean globalParamsContains(SandAttrVal val)

Returns true if globalParams contains the specified value.

globalParamsIndexOf

public int globalParamsIndexOf(SandAttrVal val)

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

sizeofGlobalParams

public int sizeofGlobalParams()

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

getGlobalParamsFlag

public static boolean getGlobalParamsFlag(int fieldflag)

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

getGlobalParamsLengthNorm

public static int getGlobalParamsLengthNorm()

Normal globalParams length is 255 characters

getGlobalParamsLengthMax

public static int getGlobalParamsLengthMax()

Maximum globalParams length is 8192 characters

getGlobalParamsDefaultValue

public static SandAttrVal[] getGlobalParamsDefaultValue()

Default value for globalParams. Returns new SandAttrVal[0]

getGlobalParamsElementInvalidValue

public static SandAttrVal getGlobalParamsElementInvalidValue()

Invalid value for globalParamselement. Returns null

getGlobalParamsInvalidValue

public static SandAttrVal[] getGlobalParamsInvalidValue()

Invalid value for globalParams. Returns null

getGlobalParamsRange

public java.lang.String getGlobalParamsRange()

Return the range specification for this field

getGlobalParamsValidityCheck

public java.lang.String getGlobalParamsValidityCheck()

getGlobalParamsMetatype

public java.lang.String getGlobalParamsMetatype()

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

getInitialData

public SandPersistMessage[] getInitialData()

Accessor for initialData

setInitialData

public void setInitialData(SandPersistMessage[] initialData)

Mutator for initialData

setInitialData

public void setInitialData(java.lang.Object[] initialData)

Generic mutator for initialData

addInitialData

public void addInitialData(SandPersistMessage element)

Appends a value to initialData

addInitialData

public void addInitialData(SandPersistMessage[] elements)

Appends an array of values to initialData

getInitialData

public SandPersistMessage getInitialData(int index)

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

setInitialData

public void setInitialData(int index,
                           SandPersistMessage value)

Set the value at the index specified.

insertInitialData

public void insertInitialData(int index,
                              SandPersistMessage 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.

removeInitialData

public SandPersistMessage removeInitialData(int index)

Remove the element at the specified index and return it.

removeInitialDataValue

public boolean removeInitialDataValue(SandPersistMessage value)

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

clearInitialData

public void clearInitialData()

Clears all values from initialData

initialDataContains

public boolean initialDataContains(SandPersistMessage val)

Returns true if initialData contains the specified value.

initialDataIndexOf

public int initialDataIndexOf(SandPersistMessage val)

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

sizeofInitialData

public int sizeofInitialData()

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

getInitialDataFlag

public static boolean getInitialDataFlag(int fieldflag)

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

getInitialDataDefaultValue

public static SandPersistMessage[] getInitialDataDefaultValue()

Default value for initialData. Returns new SandPersistMessage[0]

getInitialDataElementInvalidValue

public static SandPersistMessage getInitialDataElementInvalidValue()

Invalid value for initialDataelement. Returns null

getInitialDataInvalidValue

public static SandPersistMessage[] getInitialDataInvalidValue()

Invalid value for initialData. Returns null

getInitialDataRange

public java.lang.String getInitialDataRange()

Return the range specification for this field

getInitialDataValidityCheck

public java.lang.String getInitialDataValidityCheck()

getInitialDataMetatype

public java.lang.String getInitialDataMetatype()

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

getServers

public ServerDeclaration[] getServers()

Accessor for servers

setServers

public void setServers(ServerDeclaration[] servers)

Mutator for servers

setServers

public void setServers(java.lang.Object[] servers)

Generic mutator for servers

addServers

public void addServers(ServerDeclaration element)

Appends a value to servers

addServers

public void addServers(ServerDeclaration[] elements)

Appends an array of values to servers

getServers

public ServerDeclaration getServers(int index)

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

setServers

public void setServers(int index,
                       ServerDeclaration value)

Set the value at the index specified.

insertServers

public void insertServers(int index,
                          ServerDeclaration 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.

removeServers

public ServerDeclaration removeServers(int index)

Remove the element at the specified index and return it.

removeServersValue

public boolean removeServersValue(ServerDeclaration value)

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

clearServers

public void clearServers()

Clears all values from servers

serversContains

public boolean serversContains(ServerDeclaration val)

Returns true if servers contains the specified value.

serversIndexOf

public int serversIndexOf(ServerDeclaration val)

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

sizeofServers

public int sizeofServers()

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

getServersFlag

public static boolean getServersFlag(int fieldflag)

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

getServersDefaultValue

public static ServerDeclaration[] getServersDefaultValue()

Default value for servers. Returns new ServerDeclaration[0]

getServersElementInvalidValue

public static ServerDeclaration getServersElementInvalidValue()

Invalid value for serverselement. Returns null

getServersInvalidValue

public static ServerDeclaration[] getServersInvalidValue()

Invalid value for servers. Returns null

getServersRange

public java.lang.String getServersRange()

Return the range specification for this field

getServersValidityCheck

public java.lang.String getServersValidityCheck()

getServersMetatype

public java.lang.String getServersMetatype()

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

getNodes

public NodeInstance[] getNodes()

Accessor for nodes

setNodes

public void setNodes(NodeInstance[] nodes)

Mutator for nodes

setNodes

public void setNodes(java.lang.Object[] nodes)

Generic mutator for nodes

addNodes

public void addNodes(NodeInstance element)

Appends a value to nodes

addNodes

public void addNodes(NodeInstance[] elements)

Appends an array of values to nodes

getNodes

public NodeInstance getNodes(int index)

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

setNodes

public void setNodes(int index,
                     NodeInstance value)

Set the value at the index specified.

insertNodes

public void insertNodes(int index,
                        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.

removeNodes

public NodeInstance removeNodes(int index)

Remove the element at the specified index and return it.

removeNodesValue

public boolean removeNodesValue(NodeInstance value)

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

clearNodes

public void clearNodes()

Clears all values from nodes

nodesContains

public boolean nodesContains(NodeInstance val)

Returns true if nodes contains the specified value.

nodesIndexOf

public int nodesIndexOf(NodeInstance val)

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

sizeofNodes

public int sizeofNodes()

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

getNodesFlag

public static boolean getNodesFlag(int fieldflag)

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

getNodesDefaultValue

public static NodeInstance[] getNodesDefaultValue()

Default value for nodes. Returns new NodeInstance[0]

getNodesElementInvalidValue

public static NodeInstance getNodesElementInvalidValue()

Invalid value for nodeselement. Returns null

getNodesInvalidValue

public static NodeInstance[] getNodesInvalidValue()

Invalid value for nodes. Returns null

getNodesRange

public java.lang.String getNodesRange()

Return the range specification for this field

getNodesValidityCheck

public java.lang.String getNodesValidityCheck()

getNodesMetatype

public java.lang.String getNodesMetatype()

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

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

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

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

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

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

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

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

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 a new ConfigurationUpdate instance

Specified by:: getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new Configuration 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 cloneConfiguration

Specified by:: cloneMessage in interface SandInstanceMessage

cloneConfiguration

public Configuration cloneConfiguration()

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

copyDataFrom

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sandev.basics.sandmessages Class Configuration

sandTransmitStatus

sandTransmitErrorMessage

sandTransmissionCount

sandTransmitAuthID

Configuration

fieldHasFlag

getName

setName

setName

getNameFlag

getNameLengthNorm

getNameLengthMax

getNameDefaultValue

getNameInvalidValue

getNamePrintValue

getNameFieldPrintValue

getNameRange

getNameValidityCheck

getNameMetatype

getDescription

setDescription

setDescription

getDescriptionFlag

getDescriptionLengthNorm

getDescriptionLengthMax

getDescriptionDefaultValue

getDescriptionInvalidValue

getDescriptionPrintValue

getDescriptionFieldPrintValue

getDescriptionRange

getDescriptionValidityCheck

getDescriptionMetatype

getLoggerClass

setLoggerClass

setLoggerClass

getLoggerClassFlag

getLoggerClassLengthNorm

getLoggerClassLengthMax

getLoggerClassDefaultValue

getLoggerClassInvalidValue

getLoggerClassPrintValue

getLoggerClassFieldPrintValue

getLoggerClassRange

getLoggerClassValidityCheck

getLoggerClassMetatype

getMessagerClass

setMessagerClass

setMessagerClass

getMessagerClassFlag

getMessagerClassLengthNorm

getMessagerClassLengthMax

getMessagerClassDefaultValue

getMessagerClassInvalidValue

getMessagerClassPrintValue

getMessagerClassFieldPrintValue

getMessagerClassRange

getMessagerClassValidityCheck

getMessagerClassMetatype

getGlobalParams

setGlobalParams

setGlobalParams

addGlobalParams

addGlobalParams

getGlobalParams

setGlobalParams

insertGlobalParams

removeGlobalParams

removeGlobalParamsValue

clearGlobalParams

globalParamsContains

globalParamsIndexOf

sizeofGlobalParams

getGlobalParamsFlag

getGlobalParamsLengthNorm

getGlobalParamsLengthMax

getGlobalParamsDefaultValue

getGlobalParamsElementInvalidValue

getGlobalParamsInvalidValue

getGlobalParamsRange

org.sandev.basics.sandmessages
Class Configuration