org.sandev.ui.sandmessages
Class QueryInstance

java.lang.Object
  org.sandev.ui.structs.VerbInstanceStruct
      org.sandev.ui.structs.QueryInstanceStruct
          org.sandev.ui.sandmessages.QueryInstance

All Implemented Interfaces:

org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, VerbInstanceInterface

public class QueryInstance
extends QueryInstanceStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, VerbInstanceInterface

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.ui.structs.QueryInstanceStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:15 PM

Field Summary

static int	FUNCTION_FUNCTION_AVG Possible value for function
static int	FUNCTION_FUNCTION_COUNT Possible value for function
static int	FUNCTION_FUNCTION_DATA Possible value for function
static int	FUNCTION_FUNCTION_MAX Possible value for function
static int	FUNCTION_FUNCTION_MIN Possible value for function
static int	FUNCTION_FUNCTION_SUM Possible value for function
static int	ORDERSENSE_ORDER_ASCENDING Possible value for orderSense
static int	ORDERSENSE_ORDER_DESCENDING Possible value for orderSense
static int	ORDERSENSE_ORDER_UNSPECIFIED Possible value for orderSense
static int	SANDTRANSMITSTATUS_STATUS_APPERROR Possible value for sandTransmitStatus
static int	SANDTRANSMITSTATUS_STATUS_NORMAL Possible value for sandTransmitStatus
static int	SANDTRANSMITSTATUS_STATUS_SANDERROR Possible value for sandTransmitStatus
static int	SANDTRANSMITSTATUS_STATUS_SYSERROR Possible value for sandTransmitStatus

Fields inherited from class org.sandev.ui.structs.QueryInstanceStruct

function, matchInfo, maxReturn, operationFields, orderBy, orderSense, uniqueIDAfter

Fields inherited from class org.sandev.ui.structs.VerbInstanceStruct

baseInstanceClass, sandTransmissionCount, sandTransmitAuthID, sandTransmitErrorMessage, sandTransmitStatus

Constructor Summary

QueryInstance()
Default constructor calls init.

Method Summary

void	addMatchInfo(org.sandev.basics.structs.SandAttrVal element) Appends a value to matchInfo
void	addMatchInfo(org.sandev.basics.structs.SandAttrVal[] elements) Appends an array of values to matchInfo
void	clearMatchInfo() Clears all values from matchInfo
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneQueryInstance
QueryInstance	cloneQueryInstance() Make a deep copy of this QueryInstance.
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(QueryInstance other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
static java.lang.String	functionActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	functionLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	functionLabelToValueStatic(java.lang.String label)
static java.lang.String	functionPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	functionPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	functionValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	functionValueToLabelStatic(int val)
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
java.lang.String	getBaseInstanceClass() Accessor for baseInstanceClass
static java.lang.String	getBaseInstanceClassDefaultValue() Default value for baseInstanceClass.
java.lang.String	getBaseInstanceClassFieldPrintValue() Return the print name of the baseInstanceClass field.
static boolean	getBaseInstanceClassFlag(int fieldflag) Field flag accessor.
static java.lang.String	getBaseInstanceClassInvalidValue() Invalid value for baseInstanceClass.
static int	getBaseInstanceClassLengthMax() Maximum baseInstanceClass length is 80 characters
static int	getBaseInstanceClassLengthNorm() Normal baseInstanceClass length is 40 characters
java.lang.String	getBaseInstanceClassMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getBaseInstanceClassPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getBaseInstanceClassRange() Return the range specification for this field
java.lang.String	getBaseInstanceClassValidityCheck() 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.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayFieldsPrint() Return an array of the summary field print names for this class.
java.lang.String	getDisplayID() Return the displayID for this message instance
java.lang.String[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
int	getFunction() Accessor for function
static java.lang.String[]	getFunctionActualVals() Return an array of the possible values for this field as Strings.
static int	getFunctionDefaultValue() Default value for function.
static java.lang.String	getFunctionEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getFunctionFieldPrintValue() Return the print name of the function field.
static boolean	getFunctionFlag(int fieldflag) Field flag accessor.
static int	getFunctionInvalidValue() Invalid value for function.
static java.lang.String[]	getFunctionKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getFunctionMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getFunctionPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getFunctionPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getFunctionRange() Return the range specification for this field
java.lang.String	getFunctionValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
org.sandev.basics.structs.SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
java.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
org.sandev.basics.structs.SandAttrVal[]	getMatchInfo() Accessor for matchInfo.
org.sandev.basics.structs.SandAttrVal	getMatchInfo(int index) Returns the element at the specified index.
static org.sandev.basics.structs.SandAttrVal[]	getMatchInfoDefaultValue() Default value for matchInfo.
static org.sandev.basics.structs.SandAttrVal	getMatchInfoElementInvalidValue() Invalid value for matchInfoelement.
java.lang.String	getMatchInfoFieldPrintValue() Return the print name of the matchInfo field.
static boolean	getMatchInfoFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.structs.SandAttrVal[]	getMatchInfoInvalidValue() Invalid value for matchInfo.
java.lang.String	getMatchInfoMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getMatchInfoPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getMatchInfoRange() Return the range specification for this field
java.lang.String	getMatchInfoValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getMaxReturn() Accessor for maxReturn
static int	getMaxReturnDefaultValue() Default value for maxReturn.
java.lang.String	getMaxReturnFieldPrintValue() Return the print name of the maxReturn field.
static boolean	getMaxReturnFlag(int fieldflag) Field flag accessor.
static int	getMaxReturnInvalidValue() Invalid value for maxReturn.
java.lang.String	getMaxReturnMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getMaxReturnPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getMaxReturnRange() Return the range specification for this field
java.lang.String	getMaxReturnValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getOperationFields() Accessor for operationFields
static java.lang.String	getOperationFieldsDefaultValue() Default value for operationFields.
java.lang.String	getOperationFieldsFieldPrintValue() Return the print name of the operationFields field.
static boolean	getOperationFieldsFlag(int fieldflag) Field flag accessor.
static java.lang.String	getOperationFieldsInvalidValue() Invalid value for operationFields.
static int	getOperationFieldsLengthMax() Maximum operationFields length is 128 characters
static int	getOperationFieldsLengthNorm() Normal operationFields length is 60 characters
java.lang.String	getOperationFieldsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getOperationFieldsPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOperationFieldsRange() Return the range specification for this field
java.lang.String	getOperationFieldsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getOrderBy() Accessor for orderBy
static java.lang.String	getOrderByDefaultValue() Default value for orderBy.
java.lang.String	getOrderByFieldPrintValue() Return the print name of the orderBy field.
static boolean	getOrderByFlag(int fieldflag) Field flag accessor.
static java.lang.String	getOrderByInvalidValue() Invalid value for orderBy.
static int	getOrderByLengthMax() Maximum orderBy length is 255 characters
static int	getOrderByLengthNorm() Normal orderBy length is 60 characters
java.lang.String	getOrderByMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getOrderByPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOrderByRange() Return the range specification for this field
java.lang.String	getOrderByValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getOrderSense() Accessor for orderSense
static java.lang.String[]	getOrderSenseActualVals() Return an array of the possible values for this field as Strings.
static int	getOrderSenseDefaultValue() Default value for orderSense.
static java.lang.String	getOrderSenseEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getOrderSenseFieldPrintValue() Return the print name of the orderSense field.
static boolean	getOrderSenseFlag(int fieldflag) Field flag accessor.
static int	getOrderSenseInvalidValue() Invalid value for orderSense.
static java.lang.String[]	getOrderSenseKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getOrderSenseMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getOrderSensePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getOrderSensePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOrderSenseRange() Return the range specification for this field
java.lang.String	getOrderSenseValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getPrintname() Return the printname of the class
java.lang.String	getPrintnameForField(java.lang.String fieldname) Given a fieldname, return its declared printname if declared.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
int	getSandTransmissionCount() Accessor for sandTransmissionCount
static int	getSandTransmissionCountDefaultValue() Default value for sandTransmissionCount.
java.lang.String	getSandTransmissionCountFieldPrintValue() Return the print name of the sandTransmissionCount field.
static boolean	getSandTransmissionCountFlag(int fieldflag) Field flag accessor.
static int	getSandTransmissionCountInvalidValue() Invalid value for sandTransmissionCount.
java.lang.String	getSandTransmissionCountMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmissionCountPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmissionCountRange() Return the range specification for this field
java.lang.String	getSandTransmissionCountValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long	getSandTransmitAuthID() Accessor for sandTransmitAuthID
static long	getSandTransmitAuthIDDefaultValue() Default value for sandTransmitAuthID.
java.lang.String	getSandTransmitAuthIDFieldPrintValue() Return the print name of the sandTransmitAuthID field.
static boolean	getSandTransmitAuthIDFlag(int fieldflag) Field flag accessor.
static long	getSandTransmitAuthIDInvalidValue() Invalid value for sandTransmitAuthID.
java.lang.String	getSandTransmitAuthIDMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitAuthIDPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitAuthIDRange() Return the range specification for this field
java.lang.String	getSandTransmitAuthIDValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getSandTransmitErrorMessage() Accessor for sandTransmitErrorMessage
static java.lang.String	getSandTransmitErrorMessageDefaultValue() Default value for sandTransmitErrorMessage.
java.lang.String	getSandTransmitErrorMessageFieldPrintValue() Return the print name of the sandTransmitErrorMessage field.
static boolean	getSandTransmitErrorMessageFlag(int fieldflag) Field flag accessor.
static java.lang.String	getSandTransmitErrorMessageInvalidValue() Invalid value for sandTransmitErrorMessage.
static int	getSandTransmitErrorMessageLengthMax() Maximum sandTransmitErrorMessage length is 255 characters
static int	getSandTransmitErrorMessageLengthNorm() Normal sandTransmitErrorMessage length is 60 characters
java.lang.String	getSandTransmitErrorMessageMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitErrorMessagePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitErrorMessageRange() Return the range specification for this field
java.lang.String	getSandTransmitErrorMessageValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getSandTransmitStatus() Accessor for sandTransmitStatus
static java.lang.String[]	getSandTransmitStatusActualVals() Return an array of the possible values for this field as Strings.
static int	getSandTransmitStatusDefaultValue() Default value for sandTransmitStatus.
static java.lang.String	getSandTransmitStatusEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getSandTransmitStatusFieldPrintValue() Return the print name of the sandTransmitStatus field.
static boolean	getSandTransmitStatusFlag(int fieldflag) Field flag accessor.
static int	getSandTransmitStatusInvalidValue() Invalid value for sandTransmitStatus.
static java.lang.String[]	getSandTransmitStatusKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getSandTransmitStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getSandTransmitStatusPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getSandTransmitStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitStatusRange() Return the range specification for this field
java.lang.String	getSandTransmitStatusValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new QueryInstance instance
long	getUniqueIDAfter() Accessor for uniqueIDAfter
static long	getUniqueIDAfterDefaultValue() Default value for uniqueIDAfter.
java.lang.String	getUniqueIDAfterFieldPrintValue() Return the print name of the uniqueIDAfter field.
static boolean	getUniqueIDAfterFlag(int fieldflag) Field flag accessor.
static long	getUniqueIDAfterInvalidValue() Invalid value for uniqueIDAfter.
java.lang.String	getUniqueIDAfterMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getUniqueIDAfterPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getUniqueIDAfterRange() Return the range specification for this field
java.lang.String	getUniqueIDAfterValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
void	insertMatchInfo(int index, org.sandev.basics.structs.SandAttrVal value) Insert the specified element at the specified index.
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
boolean	matchInfoContains(org.sandev.basics.structs.SandAttrVal val) Returns true if matchInfo contains the specified value.
int	matchInfoIndexOf(org.sandev.basics.structs.SandAttrVal val) Return the index of the specified value in matchInfo, or -1 if not found.
static java.lang.String	orderSenseActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	orderSenseLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	orderSenseLabelToValueStatic(java.lang.String label)
static java.lang.String	orderSensePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	orderSensePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	orderSenseValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	orderSenseValueToLabelStatic(int val)
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
org.sandev.basics.structs.SandAttrVal	removeMatchInfo(int index) Remove the element at the specified index and return it.
boolean	removeMatchInfoValue(org.sandev.basics.structs.SandAttrVal value) Removes the given element from matchInfo.
static java.lang.String	sandTransmitStatusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	sandTransmitStatusLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	sandTransmitStatusLabelToValueStatic(java.lang.String label)
static java.lang.String	sandTransmitStatusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	sandTransmitStatusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	sandTransmitStatusValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	sandTransmitStatusValueToLabelStatic(int val)
void	setBaseInstanceClass(java.lang.Object baseInstanceClass) Generic mutator for baseInstanceClass
void	setBaseInstanceClass(java.lang.String baseInstanceClass) Mutator for baseInstanceClass
void	setFunction(int function) Mutator for function
void	setMatchInfo(int index, org.sandev.basics.structs.SandAttrVal value) Set the value at the index specified.
void	setMatchInfo(java.lang.Object[] matchInfo) Generic mutator for matchInfo
void	setMatchInfo(org.sandev.basics.structs.SandAttrVal[] matchInfo) Mutator for matchInfo
void	setMaxReturn(int maxReturn) Mutator for maxReturn
void	setOperationFields(java.lang.Object operationFields) Generic mutator for operationFields
void	setOperationFields(java.lang.String operationFields) Mutator for operationFields
void	setOrderBy(java.lang.Object orderBy) Generic mutator for orderBy
void	setOrderBy(java.lang.String orderBy) Mutator for orderBy
void	setOrderSense(int orderSense) Mutator for orderSense
void	setSandTransmissionCount(int sandTransmissionCount) Mutator for sandTransmissionCount
void	setSandTransmitAuthID(long sandTransmitAuthID) Mutator for sandTransmitAuthID
void	setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage) Generic mutator for sandTransmitErrorMessage
void	setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage) Mutator for sandTransmitErrorMessage
void	setSandTransmitStatus(int sandTransmitStatus) Mutator for sandTransmitStatus
void	setUniqueIDAfter(long uniqueIDAfter) Mutator for uniqueIDAfter
QueryInstance	shallowCopy() Make a shallow copy of this QueryInstance.
int	sizeofMatchInfo() Returns the size of matchInfo.
java.lang.String	toString() Return a string representation of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SANDTRANSMITSTATUS_STATUS_NORMAL

public static final int SANDTRANSMITSTATUS_STATUS_NORMAL

Possible value for sandTransmitStatus

See Also:

Constant Field Values

SANDTRANSMITSTATUS_STATUS_SYSERROR

public static final int SANDTRANSMITSTATUS_STATUS_SYSERROR

Possible value for sandTransmitStatus

See Also:

Constant Field Values

SANDTRANSMITSTATUS_STATUS_SANDERROR

public static final int SANDTRANSMITSTATUS_STATUS_SANDERROR

Possible value for sandTransmitStatus

See Also:

Constant Field Values

SANDTRANSMITSTATUS_STATUS_APPERROR

public static final int SANDTRANSMITSTATUS_STATUS_APPERROR

Possible value for sandTransmitStatus

See Also:

Constant Field Values

ORDERSENSE_ORDER_UNSPECIFIED

public static final int ORDERSENSE_ORDER_UNSPECIFIED

Possible value for orderSense

See Also:

Constant Field Values

ORDERSENSE_ORDER_ASCENDING

public static final int ORDERSENSE_ORDER_ASCENDING

Possible value for orderSense

See Also:

Constant Field Values

ORDERSENSE_ORDER_DESCENDING

public static final int ORDERSENSE_ORDER_DESCENDING

Possible value for orderSense

See Also:

Constant Field Values

FUNCTION_FUNCTION_DATA

public static final int FUNCTION_FUNCTION_DATA

Possible value for function

See Also:

Constant Field Values

FUNCTION_FUNCTION_COUNT

public static final int FUNCTION_FUNCTION_COUNT

Possible value for function

See Also:

Constant Field Values

FUNCTION_FUNCTION_AVG

public static final int FUNCTION_FUNCTION_AVG

Possible value for function

See Also:

Constant Field Values

FUNCTION_FUNCTION_MAX

public static final int FUNCTION_FUNCTION_MAX

Possible value for function

See Also:

Constant Field Values

FUNCTION_FUNCTION_MIN

public static final int FUNCTION_FUNCTION_MIN

Possible value for function

See Also:

Constant Field Values

FUNCTION_FUNCTION_SUM

public static final int FUNCTION_FUNCTION_SUM

Possible value for function

See Also:

Constant Field Values

Constructor Detail

QueryInstance

public QueryInstance()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

getPrintname in interface org.sandev.basics.structs.SandStructMessage

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)

Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.

Specified by:

fieldHasFlag in interface org.sandev.basics.structs.SandInstanceMessage

getBaseInstanceClass

public java.lang.String getBaseInstanceClass()

Accessor for baseInstanceClass

Specified by:

getBaseInstanceClass in interface VerbInstanceInterface

setBaseInstanceClass

public void setBaseInstanceClass(java.lang.String baseInstanceClass)

Mutator for baseInstanceClass

Specified by:

setBaseInstanceClass in interface VerbInstanceInterface

setBaseInstanceClass

public void setBaseInstanceClass(java.lang.Object baseInstanceClass)

Generic mutator for baseInstanceClass

Specified by:

setBaseInstanceClass in interface VerbInstanceInterface

getBaseInstanceClassFlag

public static boolean getBaseInstanceClassFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getBaseInstanceClassLengthNorm

public static int getBaseInstanceClassLengthNorm()

Normal baseInstanceClass length is 40 characters

getBaseInstanceClassLengthMax

public static int getBaseInstanceClassLengthMax()

Maximum baseInstanceClass length is 80 characters

getBaseInstanceClassDefaultValue

public static java.lang.String getBaseInstanceClassDefaultValue()

Default value for baseInstanceClass. Returns ""

getBaseInstanceClassInvalidValue

public static java.lang.String getBaseInstanceClassInvalidValue()

Invalid value for baseInstanceClass. Returns null

getBaseInstanceClassPrintValue

public java.lang.String getBaseInstanceClassPrintValue()

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.

getBaseInstanceClassFieldPrintValue

public java.lang.String getBaseInstanceClassFieldPrintValue()

Return the print name of the baseInstanceClass field. If no printname is declared then this returns the field name.

getBaseInstanceClassRange

public java.lang.String getBaseInstanceClassRange()

Return the range specification for this field

getBaseInstanceClassValidityCheck

public java.lang.String getBaseInstanceClassValidityCheck()

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.

getBaseInstanceClassMetatype

public java.lang.String getBaseInstanceClassMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getSandTransmitStatus

public int getSandTransmitStatus()

Accessor for sandTransmitStatus

Specified by:

getSandTransmitStatus in interface VerbInstanceInterface

setSandTransmitStatus

public void setSandTransmitStatus(int sandTransmitStatus)

Mutator for sandTransmitStatus

Specified by:

setSandTransmitStatus in interface VerbInstanceInterface

sandTransmitStatusValueToLabel

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

sandTransmitStatusValueToLabelStatic

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

sandTransmitStatusLabelToValue

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

sandTransmitStatusLabelToValueStatic

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

getSandTransmitStatusPrintVals

public static java.lang.String[] getSandTransmitStatusPrintVals()

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.

getSandTransmitStatusKeyVals

public static java.lang.String[] getSandTransmitStatusKeyVals()

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.

getSandTransmitStatusActualVals

public static java.lang.String[] getSandTransmitStatusActualVals()

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

sandTransmitStatusPrint2Key

public static java.lang.String sandTransmitStatusPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getSandTransmitStatusPrintVals and getSandTransmitStatusKeyVals methods for details.

sandTransmitStatusPrint2Actual

public static java.lang.String sandTransmitStatusPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getSandTransmitStatusPrintVals and getSandTransmitStatusActualVals methods for details.

sandTransmitStatusActual2Print

public static java.lang.String sandTransmitStatusActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getSandTransmitStatusActualVals and getSandTransmitStatusPrintVals methods for details.

getSandTransmitStatusEnumSummary

public static java.lang.String getSandTransmitStatusEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getSandTransmitStatusFlag

public static boolean getSandTransmitStatusFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getSandTransmitStatusDefaultValue

public static int getSandTransmitStatusDefaultValue()

Default value for sandTransmitStatus. Returns 0

getSandTransmitStatusInvalidValue

public static int getSandTransmitStatusInvalidValue()

Invalid value for sandTransmitStatus. Returns -1

getSandTransmitStatusPrintValue

public java.lang.String getSandTransmitStatusPrintValue()

R