org.sandev.basics.Authorizer
Class AuthorizerNodeInstance

java.lang.Object
  extended by org.sandev.basics.Authorizer.AuthorizerNodeDecl
      extended by org.sandev.basics.Authorizer.AuthorizerNodeInstance
All Implemented Interfaces:
NodeInstance, SandInstanceMessage, SandMessage, Resolvable

public class AuthorizerNodeInstance
extends AuthorizerNodeDecl
implements NodeInstance, Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.Authorizer.AuthorizerNodeDecl
generator: org.sandev.generator.NodeInstClassGenerator
time: Jul 31, 2008 4:34:14 PM

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


Field Summary
protected  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  java.lang.String servername
          The name of the server this instance will be running on.
 
Fields inherited from class org.sandev.basics.Authorizer.AuthorizerNodeDecl
authFilterClassName, encryptorName, peerAuthUserLookupNode, peerIDLookupNode, serializerClassName
 
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
AuthorizerNodeInstance()
          Default constructor calls init.
 
Method Summary
 void addHelperNodes(NodeInstance element)
          Appends a value to helperNodes
 void addHelperNodes(NodeInstance[] elements)
          Appends an array of values to helperNodes
 void clearHelperNodes()
          Clears all values from helperNodes
 AuthorizerNodeInstance cloneAuthorizerNodeInstance()
          Make a deep copy of this AuthorizerNodeInstance.
 SandInstanceMessage cloneMessage()
          Calls cloneAuthorizerNodeInstance
 SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(AuthorizerNodeInstance other, boolean deepcopy)
          Copy all the data from the specified instance.
 void copyFieldValue(java.lang.String fieldName, SandInstanceMessage other)
          Copy the specified field from the given instance.
 java.lang.String debugDump(java.lang.String prefix)
          Dump this instance into a debug printable string.
 void defaultField(java.lang.String fieldname)
          Set the specified field to its default value.
 boolean fieldHasFlag(java.lang.String fieldname, int fieldflag)
          Return true if the named field declares the indicated flag, false otherwise.
 boolean fieldsValid()
          Validate the fields as specified in the SandInstanceMessage interface
 SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)
          Validate the fields as specified in the SandInstanceMessage interface
 java.lang.Object generalAccessor(java.lang.String fieldspec)
          General field accessor method.
 SandAttrVal generalDereference(java.lang.String fieldspec)
          General reference field accessor method.
 void generalModifier(int action, java.lang.String field, int index, java.lang.Object val)
          General mutator method.
 java.lang.String[] getAllFields()
          Return an array of all fields for this class.
 java.lang.String getAuthFilterClassName()
          Accessor for authFilterClassName
static java.lang.String getAuthFilterClassNameDefaultValue()
          Default value for authFilterClassName.
 java.lang.String getAuthFilterClassNameFieldPrintValue()
          Return the print name of the authFilterClassName field.
static boolean getAuthFilterClassNameFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getAuthFilterClassNameInvalidValue()
          Invalid value for authFilterClassName.
static int getAuthFilterClassNameLengthMax()
          Maximum authFilterClassName length is 120 characters
static int getAuthFilterClassNameLengthNorm()
          Normal authFilterClassName length is 60 characters
 java.lang.String getAuthFilterClassNameMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getAuthFilterClassNamePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getAuthFilterClassNameRange()
          Return the range specification for this field
 java.lang.String getAuthFilterClassNameValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getBaseMemoryUse()
          Return the base memory use for this object.
 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(IDLookup lookup, AuthUser user, java.lang.String defaultVal)
          Return the values for the summary fields, including dereference expressions.
 java.lang.String getEncryptorName()
          Accessor for encryptorName
static java.lang.String getEncryptorNameDefaultValue()
          Default value for encryptorName.
 java.lang.String getEncryptorNameFieldPrintValue()
          Return the print name of the encryptorName field.
static boolean getEncryptorNameFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getEncryptorNameInvalidValue()
          Invalid value for encryptorName.
static int getEncryptorNameLengthMax()
          Maximum encryptorName length is 120 characters
static int getEncryptorNameLengthNorm()
          Normal encryptorName length is 60 characters
 java.lang.String getEncryptorNameMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getEncryptorNamePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getEncryptorNameRange()
          Return the range specification for this field
 java.lang.String getEncryptorNameValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 NodeInstance[] getHelperNodes()
          Accessor for helperNodes.
 NodeInstance getHelperNodes(int index)
          Returns the element at the specified index.
static NodeInstance[] getHelperNodesDefaultValue()
          Default value for helperNodes.
static 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 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 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.
 java.lang.String getPeerAuthUserLookupNode()
          Accessor for peerAuthUserLookupNode
static java.lang.String getPeerAuthUserLookupNodeDefaultValue()
          Default value for peerAuthUserLookupNode.
 java.lang.String getPeerAuthUserLookupNodeFieldPrintValue()
          Return the print name of the peerAuthUserLookupNode field.
static boolean getPeerAuthUserLookupNodeFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getPeerAuthUserLookupNodeInvalidValue()
          Invalid value for peerAuthUserLookupNode.
static int getPeerAuthUserLookupNodeLengthMax()
          Maximum peerAuthUserLookupNode length is 60 characters
static int getPeerAuthUserLookupNodeLengthNorm()
          Normal peerAuthUserLookupNode length is 30 characters
 java.lang.String getPeerAuthUserLookupNodeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getPeerAuthUserLookupNodePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getPeerAuthUserLookupNodeRange()
          Return the range specification for this field
 java.lang.String getPeerAuthUserLookupNodeValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getPeerIDLookupNode()
          Accessor for peerIDLookupNode
static java.lang.String getPeerIDLookupNodeDefaultValue()
          Default value for peerIDLookupNode.
 java.lang.String getPeerIDLookupNodeFieldPrintValue()
          Return the print name of the peerIDLookupNode field.
static boolean getPeerIDLookupNodeFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getPeerIDLookupNodeInvalidValue()
          Invalid value for peerIDLookupNode.
static int getPeerIDLookupNodeLengthMax()
          Maximum peerIDLookupNode length is 60 characters
static int getPeerIDLookupNodeLengthNorm()
          Normal peerIDLookupNode length is 30 characters
 java.lang.String getPeerIDLookupNodeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getPeerIDLookupNodePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getPeerIDLookupNodeRange()
          Return the range specification for this field
 java.lang.String getPeerIDLookupNodeValidityCheck()
          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.
 SandQueryMessage getQueryMessage()
          Returns null
 java.lang.String getSerializerClassName()
          Accessor for serializerClassName
static java.lang.String getSerializerClassNameDefaultValue()
          Default value for serializerClassName.
 java.lang.String getSerializerClassNameFieldPrintValue()
          Return the print name of the serializerClassName field.
static boolean getSerializerClassNameFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getSerializerClassNameInvalidValue()
          Invalid value for serializerClassName.
static int getSerializerClassNameLengthMax()
          Maximum serializerClassName length is 120 characters
static int getSerializerClassNameLengthNorm()
          Normal serializerClassName length is 60 characters
 java.lang.String getSerializerClassNameMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSerializerClassNamePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSerializerClassNameRange()
          Return the range specification for this field
 java.lang.String getSerializerClassNameValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 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.
 SandStructMessage getStructMessage()
          Returns a new AuthorizerNodeInstance instance
 SandUpdateMessage getUpdateMessage()
          Returns null
 java.lang.String getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal)
          Returns the print representation of the value of the specified field, or the given default value if innaccessible.
 boolean helperNodesContains(NodeInstance val)
          Returns true if helperNodes contains the specified value.
 int helperNodesIndexOf(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, NodeInstance value)
          Insert the specified element at the specified index.
 boolean isEquivalent(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, IDLookup idlookup, NameLookup namelookup, AuthUser au)
          Validate the references as specified in the Resolvable interface.
 NodeInstance removeHelperNodes(int index)
          Remove the element at the specified index and return it.
 boolean removeHelperNodesValue(NodeInstance value)
          Removes the given element from helperNodes.
 ServerDeclaration resolveServernameReference(NameLookup lookup, AuthUser au)
          Converts a reference to an instance by looking it up.
 ServerDeclaration resolveServernameReferenceNonCrit(NameLookup lookup, AuthUser au)
          Calls standard method, eating any SandException and returning a new instance with all default values instead.
 void setAuthFilterClassName(java.lang.Object authFilterClassName)
          Generic mutator for authFilterClassName
 void setAuthFilterClassName(java.lang.String authFilterClassName)
          Mutator for authFilterClassName
 void setEncryptorName(java.lang.Object encryptorName)
          Generic mutator for encryptorName
 void setEncryptorName(java.lang.String encryptorName)
          Mutator for encryptorName
 void setHelperNodes(int index, NodeInstance value)
          Set the value at the index specified.
 void setHelperNodes(NodeInstance[] helperNodes)
          Mutator for helperNodes
 void setHelperNodes(java.lang.Object[] helperNodes)
          Generic mutator for helperNodes
 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 setPeerAuthUserLookupNode(java.lang.Object peerAuthUserLookupNode)
          Generic mutator for peerAuthUserLookupNode
 void setPeerAuthUserLookupNode(java.lang.String peerAuthUserLookupNode)
          Mutator for peerAuthUserLookupNode
 void setPeerIDLookupNode(java.lang.Object peerIDLookupNode)
          Generic mutator for peerIDLookupNode
 void setPeerIDLookupNode(java.lang.String peerIDLookupNode)
          Mutator for peerIDLookupNode
 void setSerializerClassName(java.lang.Object serializerClassName)
          Generic mutator for serializerClassName
 void setSerializerClassName(java.lang.String serializerClassName)
          Mutator for serializerClassName
 void setServername(java.lang.Object servername)
          Generic mutator for servername
 void setServername(java.lang.String servername)
          Mutator for servername
 AuthorizerNodeInstance shallowCopy()
          Make a shallow copy of this AuthorizerNodeInstance.
 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 NodeInstance[] helperNodes
Additional nodes instantiated with this node running together as a logical subsystem.


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

AuthorizerNodeInstance

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

getSerializerClassName

public java.lang.String getSerializerClassName()
Accessor for serializerClassName


setSerializerClassName

public void setSerializerClassName(java.lang.String serializerClassName)
Mutator for serializerClassName


setSerializerClassName

public void setSerializerClassName(java.lang.Object serializerClassName)
Generic mutator for serializerClassName


getSerializerClassNameFlag

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


getSerializerClassNameLengthNorm

public static int getSerializerClassNameLengthNorm()
Normal serializerClassName length is 60 characters


getSerializerClassNameLengthMax

public static int getSerializerClassNameLengthMax()
Maximum serializerClassName length is 120 characters


getSerializerClassNameDefaultValue

public static java.lang.String getSerializerClassNameDefaultValue()
Default value for serializerClassName. Returns "org.sandev.tools.util.XMLSerializer"


getSerializerClassNameInvalidValue

public static java.lang.String getSerializerClassNameInvalidValue()
Invalid value for serializerClassName. Returns "AUTHORIZER_INVALID_SERIALIZER"


getSerializerClassNamePrintValue

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


getSerializerClassNameFieldPrintValue

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


getSerializerClassNameRange

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


getSerializerClassNameValidityCheck

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


getSerializerClassNameMetatype

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


getEncryptorName

public java.lang.String getEncryptorName()
Accessor for encryptorName


setEncryptorName

public void setEncryptorName(java.lang.String encryptorName)
Mutator for encryptorName


setEncryptorName

public void setEncryptorName(java.lang.Object encryptorName)
Generic mutator for encryptorName


getEncryptorNameFlag

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


getEncryptorNameLengthNorm

public static int getEncryptorNameLengthNorm()
Normal encryptorName length is 60 characters


getEncryptorNameLengthMax

public static int getEncryptorNameLengthMax()
Maximum encryptorName length is 120 characters


getEncryptorNameDefaultValue

public static java.lang.String getEncryptorNameDefaultValue()
Default value for encryptorName. Returns "org.sandev.basics.util.NullEncryptor"


getEncryptorNameInvalidValue

public static java.lang.String getEncryptorNameInvalidValue()
Invalid value for encryptorName. Returns "AUTHORIZER_INVALID_ENCRYPTOR"


getEncryptorNamePrintValue

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


getEncryptorNameFieldPrintValue

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


getEncryptorNameRange

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


getEncryptorNameValidityCheck

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


getEncryptorNameMetatype

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


getAuthFilterClassName

public java.lang.String getAuthFilterClassName()
Accessor for authFilterClassName


setAuthFilterClassName

public void setAuthFilterClassName(java.lang.String authFilterClassName)
Mutator for authFilterClassName


setAuthFilterClassName

public void setAuthFilterClassName(java.lang.Object authFilterClassName)
Generic mutator for authFilterClassName


getAuthFilterClassNameFlag

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


getAuthFilterClassNameLengthNorm

public static int getAuthFilterClassNameLengthNorm()
Normal authFilterClassName length is 60 characters


getAuthFilterClassNameLengthMax

public static int getAuthFilterClassNameLengthMax()
Maximum authFilterClassName length is 120 characters


getAuthFilterClassNameDefaultValue

public static java.lang.String getAuthFilterClassNameDefaultValue()
Default value for authFilterClassName. Returns "org.sandev.basics.Authorizer.DummyAuthFilter"


getAuthFilterClassNameInvalidValue

public static java.lang.String getAuthFilterClassNameInvalidValue()
Invalid value for authFilterClassName. Returns "AUTHORIZER_INVALID_AUTHFILTER"


getAuthFilterClassNamePrintValue

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


getAuthFilterClassNameFieldPrintValue

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


getAuthFilterClassNameRange

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


getAuthFilterClassNameValidityCheck

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


getAuthFilterClassNameMetatype

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


getPeerAuthUserLookupNode

public java.lang.String getPeerAuthUserLookupNode()
Accessor for peerAuthUserLookupNode


setPeerAuthUserLookupNode

public void setPeerAuthUserLookupNode(java.lang.String peerAuthUserLookupNode)
Mutator for peerAuthUserLookupNode


setPeerAuthUserLookupNode

public void setPeerAuthUserLookupNode(java.lang.Object peerAuthUserLookupNode)
Generic mutator for peerAuthUserLookupNode


getPeerAuthUserLookupNodeFlag

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


getPeerAuthUserLookupNodeLengthNorm

public static int getPeerAuthUserLookupNodeLengthNorm()
Normal peerAuthUserLookupNode length is 30 characters


getPeerAuthUserLookupNodeLengthMax

public static int getPeerAuthUserLookupNodeLengthMax()
Maximum peerAuthUserLookupNode length is 60 characters


getPeerAuthUserLookupNodeDefaultValue

public static java.lang.String getPeerAuthUserLookupNodeDefaultValue()
Default value for peerAuthUserLookupNode. Returns ""


getPeerAuthUserLookupNodeInvalidValue

public static java.lang.String getPeerAuthUserLookupNodeInvalidValue()
Invalid value for peerAuthUserLookupNode. Returns null


getPeerAuthUserLookupNodePrintValue

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


getPeerAuthUserLookupNodeFieldPrintValue

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


getPeerAuthUserLookupNodeRange

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


getPeerAuthUserLookupNodeValidityCheck

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


getPeerAuthUserLookupNodeMetatype

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


getPeerIDLookupNode

public java.lang.String getPeerIDLookupNode()
Accessor for peerIDLookupNode


setPeerIDLookupNode

public void setPeerIDLookupNode(java.lang.String peerIDLookupNode)
Mutator for peerIDLookupNode


setPeerIDLookupNode

public void setPeerIDLookupNode(java.lang.Object peerIDLookupNode)
Generic mutator for peerIDLookupNode


getPeerIDLookupNodeFlag

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


getPeerIDLookupNodeLengthNorm

public static int getPeerIDLookupNodeLengthNorm()
Normal peerIDLookupNode length is 30 characters


getPeerIDLookupNodeLengthMax

public static int getPeerIDLookupNodeLengthMax()
Maximum peerIDLookupNode length is 60 characters


getPeerIDLookupNodeDefaultValue

public static java.lang.String getPeerIDLookupNodeDefaultValue()
Default value for peerIDLookupNode. Returns ""


getPeerIDLookupNodeInvalidValue

public static java.lang.String getPeerIDLookupNodeInvalidValue()
Invalid value for peerIDLookupNode. Returns null


getPeerIDLookupNodePrintValue

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


getPeerIDLookupNodeFieldPrintValue

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


getPeerIDLookupNodeRange

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


getPeerIDLookupNodeValidityCheck

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


getPeerIDLookupNodeMetatype

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

setServername

public void setServername(java.lang.String servername)
Mutator for servername

Specified by:
setServername in interface 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 ServerDeclaration resolveServernameReferenceNonCrit(NameLookup lookup,
                                                           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 ServerDeclaration resolveServernameReference(NameLookup lookup,
                                                    AuthUser au)
                                             throws SandException
Converts a reference to an instance by looking it up.

Throws:
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 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 NodeInstance

setHelperNodes

public void setHelperNodes(NodeInstance[] helperNodes)
Mutator for helperNodes

Specified by:
setHelperNodes in interface NodeInstance

setHelperNodes

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


addHelperNodes

public void addHelperNodes(NodeInstance element)
Appends a value to helperNodes


addHelperNodes

public void addHelperNodes(NodeInstance[] elements)
Appends an array of values to helperNodes


getHelperNodes

public 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,
                           NodeInstance value)
Set the value at the index specified.


insertHelperNodes

public void insertHelperNodes(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.


removeHelperNodes

public NodeInstance removeHelperNodes(int index)
Remove the element at the specified index and return it.


removeHelperNodesValue

public boolean removeHelperNodesValue(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(NodeInstance val)
Returns true if helperNodes contains the specified value.


helperNodesIndexOf

public int helperNodesIndexOf(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 NodeInstance[] getHelperNodesDefaultValue()
Default value for helperNodes. Returns new org.sandev.basics.structs.NodeInstance[0]


getHelperNodesElementInvalidValue

public static NodeInstance getHelperNodesElementInvalidValue()
Invalid value for helperNodeselement. Returns null


getHelperNodesInvalidValue

public static 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.


getLogLevel

public int getLogLevel()
Accessor for logLevel

Specified by:
getLogLevel in interface NodeInstance

setLogLevel

public void setLogLevel(int logLevel)
Mutator for logLevel

Specified by:
setLogLevel in interface 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 SandMessage

getQueryMessage

public SandQueryMessage getQueryMessage()
Returns null

Specified by:
getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()
Returns null

Specified by:
getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()
Returns null

Specified by:
getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()
Returns a new AuthorizerNodeInstance 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.

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

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()
Return an array of the summary field print names for this class.

Specified by:
getDisplayFieldsPrint in interface SandInstanceMessage

getLayoutXML

public java.lang.String getLayoutXML()
Return the fieldlayout XML or null if not defined.

Specified by:
getLayoutXML 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.


getAllFields

public java.lang.String[] getAllFields()
Return an array of all fields for this class.

Specified by:
getAllFields in interface SandInstanceMessage

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()
Return an array of all contained message fields.

Specified by:
getContainedMessageFields 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

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)
Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

Specified by:
getPrintnameForField in interface SandInstanceMessage

cloneMessage

public SandInstanceMessage cloneMessage()
Calls cloneAuthorizerNodeInstance

Specified by:
cloneMessage in interface SandInstanceMessage

cloneAuthorizerNodeInstance

public AuthorizerNodeInstance cloneAuthorizerNodeInstance()
Make a deep copy of this AuthorizerNodeInstance. Creates a new instance and then calls copyDataFrom.


shallowCopy

public AuthorizerNodeInstance shallowCopy()
Make a shallow copy of this AuthorizerNodeInstance. Creates a new instance and then calls copyDataFrom.


copyDataFrom

public void copyDataFrom(AuthorizerNodeInstance other,
                         boolean deepcopy)
Copy all the data from the specified instance. If the other instance is null then this method does nothing. If deepcopy is specified then contained structs are copied, otherwise not. The one field this does not copy is instanceWriteAccess, since you need the copied instance to be writeable.


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

getDisplayID

public java.lang.String getDisplayID()
Return the displayID for this message instance

Specified by:
getDisplayID in interface SandInstanceMessage