|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.sandev.basics.structs.ConfigurationStruct
org.sandev.basics.sandmessages.Configuration
public class Configuration
AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.ConfigurationStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jun 15, 2007 11:40:44 PM
| Field Summary | |
|---|---|
protected int |
sandTransmissionCount
Counter to aid in tracking receipt of sent messages. |
protected java.util.Locale |
sandTransmissionLocale
The Locale in effect for the current transmission. |
protected long |
sandTransmitAuthID
The uniqueID of the authorized user of this message. |
protected java.lang.String |
sandTransmitErrorCode
Optional code associated with the transmission error. |
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.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 |
SandCollectionMessage |
find(SandQueryMessage sqm)
Return a matching collection of all directly contained instances matching the given query. |
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[] |
getContainedMessageFields()
Return an array of all contained message fields. |
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[] |
getDisplayFieldsPrint()
Return an array of the summary field print names for this class. |
java.lang.String |
getDisplayID()
Return the displayID for this message instance |
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. |
SandPersistMessage |
getInstance(java.lang.String classname,
long id)
If this instance directly contains the specified instance, then find it and return it. |
SandInstanceMessage |
getInstance(java.lang.String classname,
java.lang.String fieldname,
java.lang.String value)
If this instance directly contains the specified instance, then find it and return it. |
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. |
java.lang.String |
getPrintname()
Return the printname of the class |
java.lang.String |
getPrintnameForField(java.lang.String fieldname)
Given a fieldname, return its declared printname if declared. |
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. |
java.util.Locale |
getSandTransmissionLocale()
Accessor for sandTransmissionLocale |
static java.util.Locale |
getSandTransmissionLocaleDefaultValue()
Default value for sandTransmissionLocale. |
java.lang.String |
getSandTransmissionLocaleFieldPrintValue()
Return the print name of the sandTransmissionLocale field. |
static boolean |
getSandTransmissionLocaleFlag(int fieldflag)
Field flag accessor. |
static java.util.Locale |
getSandTransmissionLocaleInvalidValue()
Invalid value for sandTransmissionLocale. |
java.lang.String |
getSandTransmissionLocaleMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSandTransmissionLocalePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandTransmissionLocaleRange()
Return the range specification for this field |
java.lang.String |
getSandTransmissionLocaleValidityCheck()
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 |
getSandTransmitErrorCode()
Accessor for sandTransmitErrorCode |
static java.lang.String |
getSandTransmitErrorCodeDefaultValue()
Default value for sandTransmitErrorCode. |
java.lang.String |
getSandTransmitErrorCodeFieldPrintValue()
Return the print name of the sandTransmitErrorCode field. |
static boolean |
getSandTransmitErrorCodeFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getSandTransmitErrorCodeInvalidValue()
Invalid value for sandTransmitErrorCode. |
static int |
getSandTransmitErrorCodeLengthMax()
Maximum sandTransmitErrorCode length is 70 characters |
static int |
getSandTransmitErrorCodeLengthNorm()
Normal sandTransmitErrorCode length is 30 characters |
java.lang.String |
getSandTransmitErrorCodeMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSandTransmitErrorCodePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandTransmitErrorCodeRange()
Return the range specification for this field |
java.lang.String |
getSandTransmitErrorCodeValidityCheck()
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 |
setSandTransmissionLocale(java.util.Locale sandTransmissionLocale)
Mutator for sandTransmissionLocale |
void |
setSandTransmissionLocale(java.lang.Object sandTransmissionLocale)
Generic mutator for sandTransmissionLocale |
void |
setSandTransmitAuthID(long sandTransmitAuthID)
Mutator for sandTransmitAuthID |
void |
setSandTransmitError(java.lang.String code,
java.lang.String errText)
Sets both the code and the error in a single method. |
void |
setSandTransmitErrorCode(java.lang.Object sandTransmitErrorCode)
Generic mutator for sandTransmitErrorCode |
void |
setSandTransmitErrorCode(java.lang.String sandTransmitErrorCode)
Mutator for sandTransmitErrorCode |
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()
Return |