org.sandev.TaskHeap.UserLookup
Class UserLookupNodeBase

java.lang.Object
  extended by org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl
      extended by org.sandev.TaskHeap.UserLookup.UserLookupNodeBase
All Implemented Interfaces:
org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Loggable, org.sandev.basics.nodecommon.Messageable
Direct Known Subclasses:
UserLookupNode

public class UserLookupNodeBase
extends UserLookupNodeDecl
implements org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Messageable, org.sandev.basics.nodecommon.Loggable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl
generator: org.sandev.generator.NodeClassGenerator
time: Jul 31, 2008 4:34:15 PM

This file contains:


Field Summary
protected  org.sandev.basics.nodecommon.ControlWrapper[] ctrlwrappers
          The control wrappers we need to notify of state or parameter changes.
protected  org.sandev.basics.nodecommon.Controllable[] helperNodes
          Our helper nodes
protected static int LOGDEBUG
          Convenience redeclaration of corresponding Logger.LOGLEVEL constant
protected static int LOGERROR
          Convenience redeclaration of corresponding Logger.LOGLEVEL constant
protected static int LOGFATAL
          Convenience redeclaration of corresponding Logger.LOGLEVEL constant
protected  org.sandev.basics.nodecommon.Logger logger
          Logfile output at specified severity levels.
protected static int LOGINFO
          Convenience redeclaration of corresponding Logger.LOGLEVEL constant
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 static int LOGWARN
          Convenience redeclaration of corresponding Logger.LOGLEVEL constant
protected  org.sandev.basics.nodecommon.Messager messager
          Communications to and from this node.
protected  org.sandev.basics.structs.NodeInstance nodeInstance
          The declaration used to initialize this node instance when it was first created.
protected  org.sandev.basics.sandmessages.IODeclCall outgoingSyncAccountQuery
          Outbound org.sandev.TaskHeap.sandmessages.AccountQuery synchronous messaging configuration
protected  org.sandev.basics.nodecommon.Controllable parent
          Our parent node
protected  java.lang.String sandNodeErrorMessage
          Text details of the node execution error.
protected  int sandNodeState
          Runtime state of the node.
static int SANDNODESTATE_FAILED
          Possible value for sandNodeState
static int SANDNODESTATE_FAILING
          Possible value for sandNodeState
static int SANDNODESTATE_RESUMING
          Possible value for sandNodeState
static int SANDNODESTATE_RUNNING
          Possible value for sandNodeState
static int SANDNODESTATE_STARTING
          Possible value for sandNodeState
static int SANDNODESTATE_STOPPED
          Possible value for sandNodeState
static int SANDNODESTATE_STOPPING
          Possible value for sandNodeState
static int SANDNODESTATE_SUSPENDED
          Possible value for sandNodeState
static int SANDNODESTATE_SUSPENDING
          Possible value for sandNodeState
static int SANDNODESTATE_UNDEFINED
          Possible value for sandNodeState
protected  org.sandev.basics.nodecommon.SandRoot sandRoot
          Back reference to the SandRoot that launched us.
 
Fields inherited from class org.sandev.TaskHeap.UserLookup.UserLookupNodeDecl
internalCommsPassword, internalCommsUsername
 
Fields inherited from interface org.sandev.basics.nodecommon.Controllable
OPERATION_FAIL, OPERATION_RESUME, OPERATION_SHUTDOWN, OPERATION_STARTUP, OPERATION_STR_FAIL, OPERATION_STR_RESUME, OPERATION_STR_SHUTDOWN, OPERATION_STR_STARTUP, OPERATION_STR_SUSPEND, OPERATION_STR_UNDEFINED, OPERATION_STRINGS, OPERATION_SUSPEND, OPERATION_UNDEFINED, SHUTDOWN_ERROR_RESTART_GLOBAL, SHUTDOWN_ERROR_RESTART_LOCAL, SHUTDOWN_ERROR_TERMINATE, SHUTDOWN_NORMAL, STATE_FAILED, STATE_FAILING, STATE_RESUMING, STATE_RUNNING, STATE_STARTING, STATE_STOPPED, STATE_STOPPING, STATE_STR_FAILED, STATE_STR_FAILING, STATE_STR_RESUMING, STATE_STR_RUNNING, STATE_STR_STARTING, STATE_STR_STOPPED, STATE_STR_STOPPING, STATE_STR_SUSPENDED, STATE_STR_SUSPENDING, STATE_STR_UNDEFINED, STATE_STRINGS, STATE_SUSPENDED, STATE_SUSPENDING, STATE_UNDEFINED
 
Constructor Summary
UserLookupNodeBase()
          Default constructor calls init.
 
Method Summary
 void addWrapper(org.sandev.basics.nodecommon.ControlWrapper wrapper)
          Add the specified wrapper to our notification collection
 AccountCollection callAccountQuery(AccountQuery msg)
          Synchronous outbound AccountQuery
 org.sandev.basics.structs.SandCollectionMessage callQuery(org.sandev.basics.structs.SandQueryMessage sqm)
          Generalized query method to handle all queries understood by this node
 void deliver(org.sandev.basics.structs.SandMessage msg)
          Only those deliver methods explicitely declared by the node should actually be called.
 boolean fieldHasFlag(java.lang.String fieldname, int fieldflag)
          Return true if the named field declares the indicated flag, false otherwise.
 java.lang.String getDeploymentPrefix()
          Return the prefix for this deployment.
 org.sandev.basics.nodecommon.Controllable[] getHelperNodes()
          accessor for helperNodes
 org.sandev.basics.util.IDCache getIDCache()
          Retrieve an IDCache for use by this node.
 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.
 org.sandev.basics.nodecommon.Logger getLogger()
          Accessor for logger
static org.sandev.basics.nodecommon.Logger getLoggerDefaultValue()
          Default value for logger.
 java.lang.String getLoggerFieldPrintValue()
          Return the print name of the logger field.
static boolean getLoggerFlag(int fieldflag)
          Field flag accessor.
static org.sandev.basics.nodecommon.Logger getLoggerInvalidValue()
          Invalid value for logger.
 java.lang.String getLoggerMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getLoggerPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLoggerRange()
          Return the range specification for this field
 java.lang.String getLoggerValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getLogLevel()
          Accessor for logLevel
static java.lang.String[] getLogLevelActualVals()
          Return an array of the possible values for this field as Strings.
static int getLogLevelDefaultValue()
          Default value for logLevel.
static java.lang.String getLogLevelEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getLogLevelFieldPrintValue()
          Return the print name of the logLevel field.
static boolean getLogLevelFlag(int fieldflag)
          Field flag accessor.
static int getLogLevelInvalidValue()
          Invalid value for logLevel.
static java.lang.String[] getLogLevelKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getLogLevelMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getLogLevelPrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getLogLevelPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLogLevelRange()
          Return the range specification for this field
 java.lang.String getLogLevelValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.nodecommon.Messager getMessager()
          Accessor for messager
static org.sandev.basics.nodecommon.Messager getMessagerDefaultValue()
          Default value for messager.
 java.lang.String getMessagerFieldPrintValue()
          Return the print name of the messager field.
static boolean getMessagerFlag(int fieldflag)
          Field flag accessor.
static org.sandev.basics.nodecommon.Messager getMessagerInvalidValue()
          Invalid value for messager.
 java.lang.String getMessagerMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getMessagerPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getMessagerRange()
          Return the range specification for this field
 java.lang.String getMessagerValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.structs.NodeInstance getNodeInstance()
          Accessor for nodeInstance
static org.sandev.basics.structs.NodeInstance getNodeInstanceDefaultValue()
          Default value for nodeInstance.
 java.lang.String getNodeInstanceFieldPrintValue()
          Return the print name of the nodeInstance field.
static boolean getNodeInstanceFlag(int fieldflag)
          Field flag accessor.
static org.sandev.basics.structs.NodeInstance getNodeInstanceInvalidValue()
          Invalid value for nodeInstance.
 java.lang.String getNodeInstanceMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getNodeInstanceName()
          convenience wrapper method to retrieve our instance name
 java.lang.String getNodeInstancePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getNodeInstanceRange()
          Return the range specification for this field
 java.lang.String getNodeInstanceValidityCheck()
          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.
 org.sandev.basics.nodecommon.Controllable getParent()
          accessor for parent
 java.lang.String getSandNodeErrorMessage()
          Accessor for sandNodeErrorMessage
static java.lang.String getSandNodeErrorMessageDefaultValue()
          Default value for sandNodeErrorMessage.
 java.lang.String getSandNodeErrorMessageFieldPrintValue()
          Return the print name of the sandNodeErrorMessage field.
static boolean getSandNodeErrorMessageFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getSandNodeErrorMessageInvalidValue()
          Invalid value for sandNodeErrorMessage.
static int getSandNodeErrorMessageLengthMax()
          Maximum sandNodeErrorMessage length is 70 characters
static int getSandNodeErrorMessageLengthNorm()
          Normal sandNodeErrorMessage length is 30 characters
 java.lang.String getSandNodeErrorMessageMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSandNodeErrorMessagePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSandNodeErrorMessageRange()
          Return the range specification for this field
 java.lang.String getSandNodeErrorMessageValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getSandNodeState()
          Accessor for sandNodeState
static java.lang.String[] getSandNodeStateActualVals()
          Return an array of the possible values for this field as Strings.
static int getSandNodeStateDefaultValue()
          Default value for sandNodeState.
static java.lang.String getSandNodeStateEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getSandNodeStateFieldPrintValue()
          Return the print name of the sandNodeState field.
static boolean getSandNodeStateFlag(int fieldflag)
          Field flag accessor.
static int getSandNodeStateInvalidValue()
          Invalid value for sandNodeState.
static java.lang.String[] getSandNodeStateKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getSandNodeStateMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getSandNodeStatePrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getSandNodeStatePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSandNodeStateRange()
          Return the range specification for this field
 java.lang.String getSandNodeStateValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.nodecommon.SandRoot getSandRoot()
          accessor for sandRoot
 java.lang.String getServername()
          convenience wrapper method to retrieve our home server name
 void init()
          Initialize all fields to their default values
 void log(int severity, java.lang.String msg)
          Log the message with the specified severity.
 void log(java.lang.String msg)
          Shorthand for log(Logger.LOGLEVEL_INFO,msg)
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)
           
protected  void notifyStateChange(int prevState, int currState)
          Notify our registered control wrappers of our state change
protected  void onFailure()
          Override this method to do work when the node enters the failed state.
protected  void onRestart()
          Override this method to do work during startup().
protected  void onResume()
          Override this method to do work during resume().
protected  void onShutdown()
          Override this method to do work during shutdown().
protected  void onStartup()
          Override this method to do work during startup().
protected  void onSuspend()
          Override this method to do work during suspend().
protected  org.sandev.basics.structs.SandMessage processMessage(org.sandev.basics.structs.SandMessage sm)
          Process the given message and return the result.
 void readConfigParamsFromNodeInstance(org.sandev.basics.structs.NodeInstance ni)
          Read our configuration parameter values from the our node instance.
 org.sandev.basics.structs.SandMessage receive(org.sandev.basics.structs.SandMessage msg)
          Only those receive methods explicitely declared by the node should actually be called.
 void restart()
          Restarts a running node by calling shutdown and then startup
 void resume()
          Resumes a suspended node.
static java.lang.String sandNodeStateActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int sandNodeStateLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static int sandNodeStateLabelToValueStatic(java.lang.String label)
           
static java.lang.String sandNodeStatePrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String sandNodeStatePrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String sandNodeStateValueToLabel(int val)
          Given a value, return the declared label for it.
static java.lang.String sandNodeStateValueToLabelStatic(int val)
           
 void setHelperNodes(org.sandev.basics.nodecommon.Controllable[] nodes)
          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 setLogger(org.sandev.basics.nodecommon.Logger logger)
          Mutator for logger
 void setLogger(java.lang.Object logger)
          Generic mutator for logger
 void setLogLevel(int logLevel)
          Mutator for logLevel
 void setMessager(org.sandev.basics.nodecommon.Messager messager)
          Mutator for messager
 void setMessager(java.lang.Object messager)
          Generic mutator for messager
 void setNodeInstance(org.sandev.basics.structs.NodeInstance nodeInstance)
          Mutator for nodeInstance
 void setNodeInstance(java.lang.Object nodeInstance)
          Generic mutator for nodeInstance
 void setOutgoingSyncAccountQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncAccountQuery)
          Mutator for outgoingSyncAccountQuery
 void setOutgoingSyncAccountQuery(java.lang.Object outgoingSyncAccountQuery)
          Generic mutator for outgoingSyncAccountQuery
 void setParent(org.sandev.basics.nodecommon.Controllable node)
          mutator for parent
 void setSandNodeErrorMessage(java.lang.Object sandNodeErrorMessage)
          Generic mutator for sandNodeErrorMessage
 void setSandNodeErrorMessage(java.lang.String sandNodeErrorMessage)
          Mutator for sandNodeErrorMessage
 void setSandNodeState(int sandNodeState)
          Mutator for sandNodeState
 void setSandRoot(org.sandev.basics.nodecommon.SandRoot val)
          mutator for sandRoot
protected  void setupSecureReceive()
          Register us for receive with our local Authorizer
protected  void setupSubscriptions()
          Subscribe us to the nodes we need to listen to
 void shutdown()
          Stops a running node.
 void startup()
          Starts a stopped node.
 void suspend()
          Suspends a running node.
 void systemwideShutdown(int code)
          Call our shutdown, which shuts down our local nodes, then cascade this call upward to our parent so it spreads throughout the system as needed.
 boolean validTransition(int transition)
          Validates a state transition by comparing the desired transition with the current state.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

outgoingSyncAccountQuery

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncAccountQuery
Outbound org.sandev.TaskHeap.sandmessages.AccountQuery synchronous messaging configuration


sandNodeState

protected int sandNodeState
Runtime state of the node. Must be one of the STATE constants defined in Controllable


SANDNODESTATE_UNDEFINED

public static final int SANDNODESTATE_UNDEFINED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_RUNNING

public static final int SANDNODESTATE_RUNNING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_SUSPENDED

public static final int SANDNODESTATE_SUSPENDED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_STOPPED

public static final int SANDNODESTATE_STOPPED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_FAILED

public static final int SANDNODESTATE_FAILED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_STARTING

public static final int SANDNODESTATE_STARTING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_STOPPING

public static final int SANDNODESTATE_STOPPING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_SUSPENDING

public static final int SANDNODESTATE_SUSPENDING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_RESUMING

public static final int SANDNODESTATE_RESUMING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_FAILING

public static final int SANDNODESTATE_FAILING
Possible value for sandNodeState

See Also:
Constant Field Values

sandNodeErrorMessage

protected java.lang.String sandNodeErrorMessage
Text details of the node execution error.


messager

protected org.sandev.basics.nodecommon.Messager messager
Communications to and from this node.


logger

protected org.sandev.basics.nodecommon.Logger logger
Logfile output at specified severity levels.


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

nodeInstance

protected org.sandev.basics.structs.NodeInstance nodeInstance
The declaration used to initialize this node instance when it was first created. This information is for reference only, it can only be modified within the configuration.


sandRoot

protected org.sandev.basics.nodecommon.SandRoot sandRoot
Back reference to the SandRoot that launched us.


LOGDEBUG

protected static final int LOGDEBUG
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGINFO

protected static final int LOGINFO
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGWARN

protected static final int LOGWARN
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGERROR

protected static final int LOGERROR
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGFATAL

protected static final int LOGFATAL
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

parent

protected org.sandev.basics.nodecommon.Controllable parent
Our parent node


helperNodes

protected org.sandev.basics.nodecommon.Controllable[] helperNodes
Our helper nodes


ctrlwrappers

protected org.sandev.basics.nodecommon.ControlWrapper[] ctrlwrappers
The control wrappers we need to notify of state or parameter changes.

Constructor Detail

UserLookupNodeBase

public UserLookupNodeBase()
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.


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.


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.


getSandNodeState

public int getSandNodeState()
Accessor for sandNodeState

Specified by:
getSandNodeState in interface org.sandev.basics.nodecommon.Controllable

setSandNodeState

public void setSandNodeState(int sandNodeState)
Mutator for sandNodeState


sandNodeStateValueToLabel

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


sandNodeStateValueToLabelStatic

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

sandNodeStateLabelToValue

public int sandNodeStateLabelToValue(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.


sandNodeStateLabelToValueStatic

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

getSandNodeStatePrintVals

public static java.lang.String[] getSandNodeStatePrintVals()
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.


getSandNodeStateKeyVals

public static java.lang.String[] getSandNodeStateKeyVals()
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.


getSandNodeStateActualVals

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


sandNodeStatePrint2Key

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


sandNodeStatePrint2Actual

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


sandNodeStateActual2Print

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


getSandNodeStateEnumSummary

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


getSandNodeStateFlag

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


getSandNodeStateDefaultValue

public static int getSandNodeStateDefaultValue()
Default value for sandNodeState. Returns 0


getSandNodeStateInvalidValue

public static int getSandNodeStateInvalidValue()
Invalid value for sandNodeState. Returns Integer.MIN_VALUE


getSandNodeStatePrintValue

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


getSandNodeStateFieldPrintValue

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


getSandNodeStateRange

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


getSandNodeStateValidityCheck

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


getSandNodeStateMetatype

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


getSandNodeErrorMessage

public java.lang.String getSandNodeErrorMessage()
Accessor for sandNodeErrorMessage


setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.String sandNodeErrorMessage)
Mutator for sandNodeErrorMessage


setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.Object sandNodeErrorMessage)
Generic mutator for sandNodeErrorMessage


getSandNodeErrorMessageFlag

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


getSandNodeErrorMes