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.TaskHeap.UserLookup
Class UserLookupNodeInstance

java.lang.Object
  extended by org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl
      extended by org.sandev.TaskHeap.UserLookup.UserLookupNodeInstance
All Implemented Interfaces:
org.sandev.basics.structs.NodeInstance, org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.util.Resolvable
public class UserLookupNodeInstance
extends UserLookupNodeDecl
implements org.sandev.basics.structs.NodeInstance, org.sandev.basics.util.Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl
generator: org.sandev.generator.NodeInstClassGenerator
time: Jul 31, 2008 4:34:15 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  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  org.sandev.basics.sandmessages.IODeclCall outgoingSyncAccountQuery
          Outbound org.sandev.TaskHeap.sandmessages.AccountQuery synchronous messaging configuration
protected  java.lang.String servername
          The name of the server this instance will be running on.
 
Fields inherited from class org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl
internalCommsPassword, internalCommsUsername
 
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_EMPTYSTRINGPRINTVAL, 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_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET
 
Constructor Summary
UserLookupNodeInstance()
          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
 org.sandev.basics.structs.SandInstanceMessage cloneMessage()
          Calls cloneUserLookupNodeInstance
 UserLookupNodeInstance cloneUserLookupNodeInstance()
          Make a deep copy of this UserLookupNodeInstance.
 org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(UserLookupNodeInstance other, boolean deepcopy)
          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.
 int getBaseMemoryUse()
          Return the base memory use for this object.
 org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()
          Returns null
 java.lang.String[] getContainedMessageFields()
          Return an array of all contained message fields.
 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(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.
 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.
 java.lang.String getHelperNodesFieldPrintValue()
          Return the print name of the helperNodes field.
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 getHelperNodesPrintValue()
          Retrieve the current value of this field as a print String.
 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 getInternalCommsPassword()
          Accessor for internalCommsPassword
static java.lang.String getInternalCommsPasswordDefaultValue()
          Default value for internalCommsPassword.
 java.lang.String getInternalCommsPasswordFieldPrintValue()
          Return the print name of the internalCommsPassword field.
static boolean getInternalCommsPasswordFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getInternalCommsPasswordInvalidValue()
          Invalid value for internalCommsPassword.
static int getInternalCommsPasswordLengthMax()
          Maximum internalCommsPassword length is 80 characters
static int getInternalCommsPasswordLengthNorm()
          Normal internalCommsPassword length is 15 characters
 java.lang.String getInternalCommsPasswordMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getInternalCommsPasswordPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getInternalCommsPasswordRange()
          Return the range specification for this field
 java.lang.String getInternalCommsPasswordValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getInternalCommsUsername()
          Accessor for internalCommsUsername
static java.lang.String getInternalCommsUsernameDefaultValue()
          Default value for internalCommsUsername.
 java.lang.String getInternalCommsUsernameFieldPrintValue()
          Return the print name of the internalCommsUsername field.
static boolean getInternalCommsUsernameFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getInternalCommsUsernameInvalidValue()
          Invalid value for internalCommsUsername.
static int getInternalCommsUsernameLengthMax()
          Maximum internalCommsUsername length is 80 characters
static int getInternalCommsUsernameLengthNorm()
          Normal internalCommsUsername length is 15 characters
 java.lang.String getInternalCommsUsernameMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getInternalCommsUsernamePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getInternalCommsUsernameRange()
          Return the range specification for this field
 java.lang.String getInternalCommsUsernameValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getLayoutXML()
          Return the fieldlayout XML or null if not defined.
 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.sandmessages.IODeclCall getOutgoingSyncAccountQuery()
          Accessor for outgoingSyncAccountQuery
static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAccountQueryDefaultValue()
          Default value for outgoingSyncAccountQuery.
 java.lang.String getOutgoingSyncAccountQueryFieldPrintValue()
          Return the print name of the outgoingSyncAccountQuery field.
static boolean getOutgoingSyncAccountQueryFlag(int fieldflag)
          Field flag accessor.
static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAccountQueryInvalidValue()
          Invalid value for outgoingSyncAccountQuery.
 java.lang.String getOutgoingSyncAccountQueryMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getOutgoingSyncAccountQueryPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getOutgoingSyncAccountQueryRange()
          Return the range specification for this field
 java.lang.String getOutgoingSyncAccountQueryValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getPrintnameForField(java.lang.String fieldname)
          Given a fieldname, return its declared printname if declared.
 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 UserLookupNodeInstance 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 int logLevelLabelToValueStatic(java.lang.String label)
           
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.
static java.lang.String logLevelValueToLabelStatic(int val)
           
 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 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 setInternalCommsPassword(java.lang.Object internalCommsPassword)
          Generic mutator for internalCommsPassword
 void setInternalCommsPassword(java.lang.String internalCommsPassword)
          Mutator for internalCommsPassword
 void setInternalCommsUsername(java.lang.Object internalCommsUsername)
          Generic mutator for internalCommsUsername
 void setInternalCommsUsername(java.lang.String internalCommsUsername)
          Mutator for internalCommsUsername
 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 setOutgoingSyncAccountQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncAccountQuery)
          Mutator for outgoingSyncAccountQuery
 void setOutgoingSyncAccountQuery(java.lang.Object outgoingSyncAccountQuery)
          Generic mutator for outgoingSyncAccountQuery
 void setServername(java.lang.Object servername)
          Generic mutator for servername
 void setServername(java.lang.String servername)
          Mutator for servername
 UserLookupNodeInstance shallowCopy()
          Make a shallow copy of this UserLookupNodeInstance.
 int sizeofHelperNodes()
          Returns the size of helperNodes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.

outgoingSyncAccountQuery

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncAccountQuery
Outbound org.sandev.TaskHeap.sandmessages.AccountQuery 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

UserLookupNodeInstance

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

getInternalCommsUsername

public java.lang.String getInternalCommsUsername()
Accessor for internalCommsUsername

setInternalCommsUsername

public void setInternalCommsUsername(java.lang.String internalCommsUsername)
Mutator for internalCommsUsername

setInternalCommsUsername

public void setInternalCommsUsername(java.lang.Object internalCommsUsername)
Generic mutator for internalCommsUsername

getInternalCommsUsernameFlag

public static boolean getInternalCommsUsernameFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getInternalCommsUsernameLengthNorm

public static int getInternalCommsUsernameLengthNorm()
Normal internalCommsUsername length is 15 characters

getInternalCommsUsernameLengthMax

public static int getInternalCommsUsernameLengthMax()
Maximum internalCommsUsername length is 80 characters

getInternalCommsUsernameDefaultValue

public static java.lang.String getInternalCommsUsernameDefaultValue()
Default value for internalCommsUsername. Returns ""

getInternalCommsUsernameInvalidValue

public static java.lang.String getInternalCommsUsernameInvalidValue()
Invalid value for internalCommsUsername. Returns null

getInternalCommsUsernamePrintValue

public java.lang.String getInternalCommsUsernamePrintValue()
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.

getInternalCommsUsernameFieldPrintValue

public java.lang.String getInternalCommsUsernameFieldPrintValue()
Return the print name of the internalCommsUsername field. If no printname is declared then this returns the field name.

getInternalCommsUsernameRange

public java.lang.String getInternalCommsUsernameRange()
Return the range specification for this field

getInternalCommsUsernameValidityCheck

public java.lang.String getInternalCommsUsernameValidityCheck()
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.

getInternalCommsUsernameMetatype

public java.lang.String getInternalCommsUsernameMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

getInternalCommsPassword

public java.lang.String getInternalCommsPassword()
Accessor for internalCommsPassword

setInternalCommsPassword

public void setInternalCommsPassword(java.lang.String internalCommsPassword)
Mutator for internalCommsPassword

setInternalCommsPassword

public void setInternalCommsPassword(java.lang.Object internalCommsPassword)
Generic mutator for internalCommsPassword

getInternalCommsPasswordFlag

public static boolean getInternalCommsPasswordFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getInternalCommsPasswordLengthNorm

public static int getInternalCommsPasswordLengthNorm()
Normal internalCommsPassword length is 15 characters

getInternalCommsPasswordLengthMax

public static int getInternalCommsPasswordLengthMax()
Maximum internalCommsPassword length is 80 characters

getInternalCommsPasswordDefaultValue

public static java.lang.String getInternalCommsPasswordDefaultValue()
Default value for internalCommsPassword. Returns ""

getInternalCommsPasswordInvalidValue

public static java.lang.String getInternalCommsPasswordInvalidValue()
Invalid value for internalCommsPassword. Returns null

getInternalCommsPasswordPrintValue

public java.lang.String getInternalCommsPasswordPrintValue()
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.

getInternalCommsPasswordFieldPrintValue

public java.lang.String getInternalCommsPasswordFieldPrintValue()
Return the print name of the internalCommsPassword field. If no printname is declared then this returns the field name.

getInternalCommsPasswordRange

public java.lang.String getInternalCommsPasswordRange()
Return the range specification for this field

getInternalCommsPasswordValidityCheck

public java.lang.String getInternalCommsPasswordValidityCheck()
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.

getInternalCommsPasswordMetatype

public java.lang.String getInternalCommsPasswordMetatype()
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. The returned value may or may not be the actual data member. Always write back a changed array using setHelperNodes.

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 if helperNodes is null or smaller than index.

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

getHelperNodesPrintValue

public java.lang.String getHelperNodesPrintValue()
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.

getHelperNodesFieldPrintValue

public java.lang.String getHelperNodesFieldPrintValue()
Return the print name of the helperNodes field. If no printname is declared then this returns the field name.

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.

getOutgoingSyncAccountQuery

public org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAccountQuery()
Accessor for outgoingSyncAccountQuery

setOutgoingSyncAccountQuery

public void setOutgoingSyncAccountQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncAccountQuery)
Mutator for outgoingSyncAccountQuery

setOutgoingSyncAccountQuery

public void setOutgoingSyncAccountQuery(java.lang.Object outgoingSyncAccountQuery)
Generic mutator for outgoingSyncAccountQuery

getOutgoingSyncAccountQueryFlag

public static boolean getOutgoingSyncAccountQueryFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getOutgoingSyncAccountQueryDefaultValue

public static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAccountQueryDefaultValue()
Default value for outgoingSyncAccountQuery. Returns new IODeclCall()

getOutgoingSyncAccountQueryInvalidValue

public static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAccountQueryInvalidValue()
Invalid value for outgoingSyncAccountQuery. Returns null

getOutgoingSyncAccountQueryPrintValue

public java.lang.String getOutgoingSyncAccountQueryPrintValue()
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.

getOutgoingSyncAccountQueryFieldPrintValue

public java.lang.String getOutgoingSyncAccountQueryFieldPrintValue()
Return the print name of the outgoingSyncAccountQuery field. If no printname is declared then this returns the field name.

getOutgoingSyncAccountQueryRange

public java.lang.String getOutgoingSyncAccountQueryRange()
Return the range specification for this field

getOutgoingSyncAccountQueryValidityCheck

public java.lang.String getOutgoingSyncAccountQueryValidityCheck()
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.

getOutgoingSyncAccountQueryMetatype

public java.lang.String getOutgoingSyncAccountQueryMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

getLogLevel

public int getLogLevel()
Accessor for logLevel

Specified by:
getLogLevel in interface org.sandev.basics.structs.NodeInstance

setLogLevel

public void setLogLevel(int logLevel)
Mutator for logLevel

Specified by:
setLogLevel in interface org.sandev.basics.structs.NodeInstance

logLevelValueToLabel

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

logLevelValueToLabelStatic

public static java.lang.String logLevelValueToLabelStatic(int val)

logLevelLabelToValue

public int logLevelLabelToValue(java.lang.String label)
Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

logLevelLabelToValueStatic

public static int logLevelLabelToValueStatic(java.lang.String label)

getLogLevelPrintVals

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

getLogLevelKeyVals

public static java.lang.String[] getLogLevelKeyVals()
Return an array of unique keys for the values of this field. These keys are globally unique and can be used for looking up localized text without any chance of the same key being used by any other field value in the application.

getLogLevelActualVals

public static java.lang.String[] getLogLevelActualVals()
Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

logLevelPrint2Key

public static java.lang.String logLevelPrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. See the getLogLevelPrintVals and getLogLevelKeyVals methods for details.

logLevelPrint2Actual

public static java.lang.String logLevelPrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. See the getLogLevelPrintVals and getLogLevelActualVals methods for details.

logLevelActual2Print

public static java.lang.String logLevelActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. See the getLogLevelActualVals and getLogLevelPrintVals methods for details.

getLogLevelEnumSummary

public static java.lang.String getLogLevelEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes.

getLogLevelFlag

public static boolean getLogLevelFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLogLevelDefaultValue

public static int getLogLevelDefaultValue()
Default value for logLevel. Returns 0

getLogLevelInvalidValue

public static int getLogLevelInvalidValue()
Invalid value for logLevel. Returns Integer.MIN_VALUE

getLogLevelPrintValue

public java.lang.String getLogLevelPrintValue()
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.

getLogLevelFieldPrintValue

public java.lang.String getLogLevelFieldPrintValue()
Return the print name of the logLevel field. If no printname is declared then this returns the field name.

getLogLevelRange

public java.lang.String getLogLevelRange()
Return the range specification for this field

getLogLevelValidityCheck

public java.lang.String getLogLevelValidityCheck()
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.

getLogLevelMetatype

public java.lang.String getLogLevelMetatype()
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 org.sandev.basics.structs.SandMessage

getQueryMessage

public org.sandev.basics.structs.SandQueryMessage getQueryMessage()
Returns null

Specified by:
getQueryMessage in interface org.sandev.basics.structs.SandMessage

getCollectionMessage

public org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()
Returns null

Specified by:
getCollectionMessage in interface org.sandev.basics.structs.SandMessage

getUpdateMessage

public org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()
Returns null

Specified by:
getUpdateMessage in interface org.sandev.basics.structs.SandMessage

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()
Returns a new UserLookupNodeInstance instance

Specified by:
getStructMessage in interface org.sandev.basics.structs.SandMessage

isEquivalent

public boolean isEquivalent(org.sandev.basics.structs.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.

When comparing arrays, it is possible that the array elements may have been set to null as part of authorization filtering or similar unusual circumstances. A null array element is only equivalent to another null array element.

Specified by:
isEquivalent in interface org.sandev.basics.structs.SandMessage

getBaseMemoryUse

public int getBaseMemoryUse()
Return the base memory use for this object. This number is a minimum value for estimation purposes, see the comments in the SandStructMessage declaration for details.

Specified by:
getBaseMemoryUse in interface org.sandev.basics.structs.SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws org.sandev.basics.structs.SandException
General mutator method. Specified by SandInstanceMessage interface.

Specified by:
generalModifier in interface org.sandev.basics.structs.SandInstanceMessage
Throws:
org.sandev.basics.structs.SandException

generalDereference

public org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)
General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:
generalDereference in interface org.sandev.basics.structs.SandInstanceMessage

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)
General field accessor method. Specified by SandInstanceMessage interface.

Specified by:
generalAccessor in interface <