org.sandev.basics.DataManager
Class DataManagerNodeInstance

java.lang.Object
  extended by org.sandev.basics.DataManager.DataManagerNodeDecl
      extended by org.sandev.basics.DataManager.DataManagerNodeInstance
All Implemented Interfaces:
NodeInstance, SandInstanceMessage, SandMessage, Resolvable

public class DataManagerNodeInstance
extends DataManagerNodeDecl
implements NodeInstance, Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.DataManager.DataManagerNodeDecl
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  IODeclReceive incomingSyncSandMessage
          Inbound org.sandev.basics.structs.SandMessage synchronous messaging configuration
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  IODeclSend outgoingAsyncSandUpdateMessage
          Outbound org.sandev.basics.structs.SandUpdateMessage asynchronous messaging configuration
protected  java.lang.String servername
          The name of the server this instance will be running on.
static int UPDATETIMEBATCHOVERRIDE_OFF
          Possible value for updateTimeBatchOverride
static int UPDATETIMEBATCHOVERRIDE_ON
          Possible value for updateTimeBatchOverride
 
Fields inherited from class org.sandev.basics.DataManager.DataManagerNodeDecl
maxQueryReturn, maxQueryReturnSizeKb, persisterDataSource, updateTimeBatchOverride
 
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
DataManagerNodeInstance()
          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
 DataManagerNodeInstance cloneDataManagerNodeInstance()
          Make a deep copy of this DataManagerNodeInstance.
 SandInstanceMessage cloneMessage()
          Calls cloneDataManagerNodeInstance
 SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(DataManagerNodeInstance 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.
 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.
 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.
 IODeclReceive getIncomingSyncSandMessage()
          Accessor for incomingSyncSandMessage
static IODeclReceive getIncomingSyncSandMessageDefaultValue()
          Default value for incomingSyncSandMessage.
 java.lang.String getIncomingSyncSandMessageFieldPrintValue()
          Return the print name of the incomingSyncSandMessage field.
static boolean getIncomingSyncSandMessageFlag(int fieldflag)
          Field flag accessor.
static IODeclReceive getIncomingSyncSandMessageInvalidValue()
          Invalid value for incomingSyncSandMessage.
 java.lang.String getIncomingSyncSandMessageMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getIncomingSyncSandMessagePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getIncomingSyncSandMessageRange()
          Return the range specification for this field
 java.lang.String getIncomingSyncSandMessageValidityCheck()
          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.
 int getMaxQueryReturn()
          Accessor for maxQueryReturn
static int getMaxQueryReturnDefaultValue()
          Default value for maxQueryReturn.
 java.lang.String getMaxQueryReturnFieldPrintValue()
          Return the print name of the maxQueryReturn field.
static boolean getMaxQueryReturnFlag(int fieldflag)
          Field flag accessor.
static int getMaxQueryReturnInvalidValue()
          Invalid value for maxQueryReturn.
static int getMaxQueryReturnLengthMax()
          Maximum maxQueryReturn length is 20 characters
static int getMaxQueryReturnLengthNorm()
          Normal maxQueryReturn length is 5 characters
 java.lang.String getMaxQueryReturnMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getMaxQueryReturnPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getMaxQueryReturnRange()
          Return the range specification for this field
 int getMaxQueryReturnSizeKb()
          Accessor for maxQueryReturnSizeKb
static int getMaxQueryReturnSizeKbDefaultValue()
          Default value for maxQueryReturnSizeKb.
 java.lang.String getMaxQueryReturnSizeKbFieldPrintValue()
          Return the print name of the maxQueryReturnSizeKb field.
static boolean getMaxQueryReturnSizeKbFlag(int fieldflag)
          Field flag accessor.
static int getMaxQueryReturnSizeKbInvalidValue()
          Invalid value for maxQueryReturnSizeKb.
static int getMaxQueryReturnSizeKbLengthMax()
          Maximum maxQueryReturnSizeKb length is 20 characters
static int getMaxQueryReturnSizeKbLengthNorm()
          Normal maxQueryReturnSizeKb length is 5 characters
 java.lang.String getMaxQueryReturnSizeKbMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getMaxQueryReturnSizeKbPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getMaxQueryReturnSizeKbRange()
          Return the range specification for this field
 java.lang.String getMaxQueryReturnSizeKbValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getMaxQueryReturnValidityCheck()
          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.
 IODeclSend getOutgoingAsyncSandUpdateMessage()
          Accessor for outgoingAsyncSandUpdateMessage
static IODeclSend getOutgoingAsyncSandUpdateMessageDefaultValue()
          Default value for outgoingAsyncSandUpdateMessage.
 java.lang.String getOutgoingAsyncSandUpdateMessageFieldPrintValue()
          Return the print name of the outgoingAsyncSandUpdateMessage field.
static boolean getOutgoingAsyncSandUpdateMessageFlag(int fieldflag)
          Field flag accessor.
static IODeclSend getOutgoingAsyncSandUpdateMessageInvalidValue()
          Invalid value for outgoingAsyncSandUpdateMessage.
 java.lang.String getOutgoingAsyncSandUpdateMessageMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getOutgoingAsyncSandUpdateMessagePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getOutgoingAsyncSandUpdateMessageRange()
          Return the range specification for this field
 java.lang.String getOutgoingAsyncSandUpdateMessageValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getPersisterDataSource()
          Accessor for persisterDataSource
static java.lang.String getPersisterDataSourceDefaultValue()
          Default value for persisterDataSource.
 java.lang.String getPersisterDataSourceFieldPrintValue()
          Return the print name of the persisterDataSource field.
static boolean getPersisterDataSourceFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getPersisterDataSourceInvalidValue()
          Invalid value for persisterDataSource.
static int getPersisterDataSourceLengthMax()
          Maximum persisterDataSource length is 255 characters
static int getPersisterDataSourceLengthNorm()
          Normal persisterDataSource length is 60 characters
 java.lang.String getPersisterDataSourceMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getPersisterDataSourcePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getPersisterDataSourceRange()
          Return the range specification for this field
 java.lang.String getPersisterDataSourceValidityCheck()
          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 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 DataManagerNodeInstance instance
 SandUpdateMessage getUpdateMessage()
          Returns null
 int getUpdateTimeBatchOverride()
          Accessor for updateTimeBatchOverride
static java.lang.String[] getUpdateTimeBatchOverrideActualVals()
          Return an array of the possible values for this field as Strings.
static int getUpdateTimeBatchOverrideDefaultValue()
          Default value for updateTimeBatchOverride.
static java.lang.String getUpdateTimeBatchOverrideEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getUpdateTimeBatchOverrideFieldPrintValue()
          Return the print name of the updateTimeBatchOverride field.
static boolean getUpdateTimeBatchOverrideFlag(int fieldflag)
          Field flag accessor.
static int getUpdateTimeBatchOverrideInvalidValue()
          Invalid value for updateTimeBatchOverride.
static java.lang.String[] getUpdateTimeBatchOverrideKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getUpdateTimeBatchOverrideMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getUpdateTimeBatchOverridePrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getUpdateTimeBatchOverridePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getUpdateTimeBatchOverrideRange()
          Return the range specification for this field
 java.lang.String getUpdateTimeBatchOverrideValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 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.
 boolean isUpdateTimeBatchOverrideOff()
          boolean accessor for updateTimeBatchOverride value
 boolean isUpdateTimeBatchOverrideOn()
          boolean accessor for updateTimeBatchOverride value
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 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 setIncomingSyncSandMessage(IODeclReceive incomingSyncSandMessage)
          Mutator for incomingSyncSandMessage
 void setIncomingSyncSandMessage(java.lang.Object incomingSyncSandMessage)
          Generic mutator for incomingSyncSandMessage
 void setLogLevel(int logLevel)
          Mutator for logLevel
 void setMaxQueryReturn(int maxQueryReturn)
          Mutator for maxQueryReturn
 void setMaxQueryReturnSizeKb(int maxQueryReturnSizeKb)
          Mutator for maxQueryReturnSizeKb
 void setNodeInstanceName(java.lang.Object nodeInstanceName)
          Generic mutator for nodeInstanceName
 void setNodeInstanceName(java.lang.String nodeInstanceName)
          Mutator for nodeInstanceName
 void setOutgoingAsyncSandUpdateMessage(IODeclSend outgoingAsyncSandUpdateMessage)
          Mutator for outgoingAsyncSandUpdateMessage
 void setOutgoingAsyncSandUpdateMessage(java.lang.Object outgoingAsyncSandUpdateMessage)
          Generic mutator for outgoingAsyncSandUpdateMessage
 void setPersisterDataSource(java.lang.Object persisterDataSource)
          Generic mutator for persisterDataSource
 void setPersisterDataSource(java.lang.String persisterDataSource)
          Mutator for persisterDataSource
 void setServername(java.lang.Object servername)
          Generic mutator for servername
 void setServername(java.lang.String servername)
          Mutator for servername
 void setUpdateTimeBatchOverride(int updateTimeBatchOverride)
          Mutator for updateTimeBatchOverride
 DataManagerNodeInstance shallowCopy()
          Make a shallow copy of this DataManagerNodeInstance.
 int sizeofHelperNodes()
          Returns the size of helperNodes.
static java.lang.String updateTimeBatchOverrideActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int updateTimeBatchOverrideLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static int updateTimeBatchOverrideLabelToValueStatic(java.lang.String label)
           
static java.lang.String updateTimeBatchOverridePrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String updateTimeBatchOverridePrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String updateTimeBatchOverrideValueToLabel(int val)
          Given a value, return the declared label for it.
static java.lang.String updateTimeBatchOverrideValueToLabelStatic(int val)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UPDATETIMEBATCHOVERRIDE_OFF

public static final int UPDATETIMEBATCHOVERRIDE_OFF
Possible value for updateTimeBatchOverride

See Also:
Constant Field Values

UPDATETIMEBATCHOVERRIDE_ON

public static final int UPDATETIMEBATCHOVERRIDE_ON
Possible value for updateTimeBatchOverride

See Also:
Constant Field Values

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.


incomingSyncSandMessage

protected IODeclReceive incomingSyncSandMessage
Inbound org.sandev.basics.structs.SandMessage synchronous messaging configuration


outgoingAsyncSandUpdateMessage

protected IODeclSend outgoingAsyncSandUpdateMessage
Outbound org.sandev.basics.structs.SandUpdateMessage asynchronous messaging configuration


logLevel

protected int logLevel
Calls to log with severity levels less than this value will be ignored. For example, if you set this field to LOGLEVEL_WARN, then a call to log with LOGLEVEL_INFO will be ignored, while any call with LOGLEVEL_WARN/ERROR/FATAL will be processed. The log levels are defined in org.sandev.basics.nodecommon.Logger


LOGLEVEL_DEBUG

public static final int LOGLEVEL_DEBUG
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_INFO

public static final int LOGLEVEL_INFO
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_WARN

public static final int LOGLEVEL_WARN
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_ERROR

public static final int LOGLEVEL_ERROR
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_FATAL

public static final int LOGLEVEL_FATAL
Possible value for logLevel

See Also:
Constant Field Values
Constructor Detail

DataManagerNodeInstance

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

getMaxQueryReturn

public int getMaxQueryReturn()
Accessor for maxQueryReturn


setMaxQueryReturn

public void setMaxQueryReturn(int maxQueryReturn)
Mutator for maxQueryReturn


getMaxQueryReturnFlag

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


getMaxQueryReturnLengthNorm

public static int getMaxQueryReturnLengthNorm()
Normal maxQueryReturn length is 5 characters


getMaxQueryReturnLengthMax

public static int getMaxQueryReturnLengthMax()
Maximum maxQueryReturn length is 20 characters


getMaxQueryReturnDefaultValue

public static int getMaxQueryReturnDefaultValue()
Default value for maxQueryReturn. Returns 30000


getMaxQueryReturnInvalidValue

public static int getMaxQueryReturnInvalidValue()
Invalid value for maxQueryReturn. Returns Integer.MIN_VALUE


getMaxQueryReturnPrintValue

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


getMaxQueryReturnFieldPrintValue

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


getMaxQueryReturnRange

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


getMaxQueryReturnValidityCheck

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


getMaxQueryReturnMetatype

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


getMaxQueryReturnSizeKb

public int getMaxQueryReturnSizeKb()
Accessor for maxQueryReturnSizeKb


setMaxQueryReturnSizeKb

public void setMaxQueryReturnSizeKb(int maxQueryReturnSizeKb)
Mutator for maxQueryReturnSizeKb


getMaxQueryReturnSizeKbFlag

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


getMaxQueryReturnSizeKbLengthNorm

public static int getMaxQueryReturnSizeKbLengthNorm()
Normal maxQueryReturnSizeKb length is 5 characters


getMaxQueryReturnSizeKbLengthMax

public static int getMaxQueryReturnSizeKbLengthMax()
Maximum maxQueryReturnSizeKb length is 20 characters


getMaxQueryReturnSizeKbDefaultValue

public static int getMaxQueryReturnSizeKbDefaultValue()
Default value for maxQueryReturnSizeKb. Returns 524288


getMaxQueryReturnSizeKbInvalidValue

public static int getMaxQueryReturnSizeKbInvalidValue()
Invalid value for maxQueryReturnSizeKb. Returns Integer.MIN_VALUE


getMaxQueryReturnSizeKbPrintValue

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


getMaxQueryReturnSizeKbFieldPrintValue

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


getMaxQueryReturnSizeKbRange

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


getMaxQueryReturnSizeKbValidityCheck

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


getMaxQueryReturnSizeKbMetatype

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


getUpdateTimeBatchOverride

public int getUpdateTimeBatchOverride()
Accessor for updateTimeBatchOverride


setUpdateTimeBatchOverride

public void setUpdateTimeBatchOverride(int updateTimeBatchOverride)
Mutator for updateTimeBatchOverride


updateTimeBatchOverrideValueToLabel

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


updateTimeBatchOverrideValueToLabelStatic

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

updateTimeBatchOverrideLabelToValue

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


updateTimeBatchOverrideLabelToValueStatic

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

getUpdateTimeBatchOverridePrintVals

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


getUpdateTimeBatchOverrideKeyVals

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


getUpdateTimeBatchOverrideActualVals

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


updateTimeBatchOverridePrint2Key

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


updateTimeBatchOverridePrint2Actual

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


updateTimeBatchOverrideActual2Print

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


getUpdateTimeBatchOverrideEnumSummary

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


isUpdateTimeBatchOverrideOff

public boolean isUpdateTimeBatchOverrideOff()
boolean acce