org.sandev.TaskHeap.sandmessages
Class PlanQuery

java.lang.Object
  org.sandev.TaskHeap.sandmessages.PlanQuery

All Implemented Interfaces:

org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandQueryMessage, org.sandev.basics.structs.SandTransmitMessage, org.sandev.basics.structs.SandVerbMessage

public class PlanQuery

extends java.lang.Object

implements org.sandev.basics.structs.SandQueryMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.PlanStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:52 PM

Field Summary

protected int	function support for SandQueryMessage interface
static int	FUNCTION_AVG Possible value for function
static int	FUNCTION_COUNT Possible value for function
static int	FUNCTION_DATA Possible value for function
static int	FUNCTION_MAX Possible value for function
static int	FUNCTION_MIN Possible value for function
static int	FUNCTION_SUM Possible value for function
protected org.sandev.basics.structs.SandAttrVal[]	matchInfo support for SandQueryMessage interface
protected int	maxReturn support for SandQueryMessage interface
protected java.lang.String	operationFields support for SandQueryMessage interface
protected java.lang.String	orderBy support for SandQueryMessage interface
protected int	sandTransmissionCount support for SandTransmitMessage interface
protected long	sandTransmitAuthID support for SandTransmitMessage interface
protected java.lang.String	sandTransmitErrorMessage support for SandTransmitMessage interface
protected int	sandTransmitStatus support for SandTransmitMessage interface
protected long	uniqueIDAfter support for SandQueryMessage interface

Fields inherited from interface org.sandev.basics.structs.SandQueryMessage

APPERROR_FUNCTION_NOT_SUPPORTED, APPERROR_NO_OPERANDS_SPECIFIED

Fields inherited from interface org.sandev.basics.structs.SandTransmitMessage

APPERROR_NODE_UNAVAILABLE, APPERROR_NODE_UNKNOWN, APPERROR_NODE_UNREACHABLE, STATUS_APPERROR, STATUS_NORMAL, STATUS_SANDERROR, STATUS_SYSERROR

Constructor Summary

PlanQuery()
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.SandQueryMessage	cloneQuery() Return a deep copy of this query message.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
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 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.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns a new PlanCollection instance
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.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.
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	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 70 characters
static int	getOperationFieldsLengthNorm() Normal operationFields length is 30 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 70 characters
static int	getOrderByLengthNorm() Normal orderBy length is 30 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.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns a new PlanQuery instance
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 70 characters
static int	getSandTransmitErrorMessageLengthNorm() Normal sandTransmitErrorMessage length is 30 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 int	getSandTransmitStatusDefaultValue() Default value for sandTransmitStatus.
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.
java.lang.String	getSandTransmitStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
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 Plan 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 a new PlanUpdate instance
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	matches(org.sandev.basics.structs.SandStructMessage msg) As specified by the SandQueryMessage 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.
void	normalize() Fix any spacing, quoting and other issues in our match expression fields resulting from lazy input or whatever.
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.
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	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
int	sizeofMatchInfo() Returns the size of matchInfo.
java.lang.String	undecimalize(java.lang.String attr, java.lang.String val) Given an attribute name and a match value, return the undecimalized form of the match value.

Methods inherited from class java.lang.Object

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

Field Detail

sandTransmitAuthID

protected long sandTransmitAuthID

support for SandTransmitMessage interface

sandTransmitErrorMessage

protected java.lang.String sandTransmitErrorMessage

support for SandTransmitMessage interface

sandTransmitStatus

protected int sandTransmitStatus

support for SandTransmitMessage interface

sandTransmissionCount

protected int sandTransmissionCount

support for SandTransmitMessage interface

matchInfo

protected org.sandev.basics.structs.SandAttrVal[] matchInfo

support for SandQueryMessage interface

maxReturn

protected int maxReturn

support for SandQueryMessage interface

orderBy

protected java.lang.String orderBy

support for SandQueryMessage interface

uniqueIDAfter

protected long uniqueIDAfter

support for SandQueryMessage interface

function

protected int function

support for SandQueryMessage interface

FUNCTION_DATA

public static final int FUNCTION_DATA

Possible value for function

See Also:

Constant Field Values

FUNCTION_COUNT

public static final int FUNCTION_COUNT

Possible value for function

See Also:

Constant Field Values

FUNCTION_AVG

public static final int FUNCTION_AVG

Possible value for function

See Also:

Constant Field Values

FUNCTION_MAX

public static final int FUNCTION_MAX

Possible value for function

See Also:

Constant Field Values

FUNCTION_MIN

public static final int FUNCTION_MIN

Possible value for function

See Also:

Constant Field Values

FUNCTION_SUM

public static final int FUNCTION_SUM

Possible value for function

See Also:

Constant Field Values

operationFields

protected java.lang.String operationFields

support for SandQueryMessage interface

Constructor Detail

PlanQuery

public PlanQuery()

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.

getSandTransmitAuthID

public long getSandTransmitAuthID()

Accessor for sandTransmitAuthID

Specified by:

getSandTransmitAuthID in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitAuthID

public void setSandTransmitAuthID(long sandTransmitAuthID)

Mutator for sandTransmitAuthID

Specified by:

setSandTransmitAuthID in interface org.sandev.basics.structs.SandTransmitMessage

getSandTransmitAuthIDFlag

public static boolean getSandTransmitAuthIDFlag(int fieldflag)

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

getSandTransmitAuthIDDefaultValue

public static long getSandTransmitAuthIDDefaultValue()

Default value for sandTransmitAuthID. Returns 0

getSandTransmitAuthIDInvalidValue

public static long getSandTransmitAuthIDInvalidValue()

Invalid value for sandTransmitAuthID. Returns Long.MIN_VALUE

getSandTransmitAuthIDPrintValue

public java.lang.String getSandTransmitAuthIDPrintValue()

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.

getSandTransmitAuthIDFieldPrintValue

public java.lang.String getSandTransmitAuthIDFieldPrintValue()

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

getSandTransmitAuthIDRange

public java.lang.String getSandTransmitAuthIDRange()

Return the range specification for this field

getSandTransmitAuthIDValidityCheck

public java.lang.String getSandTransmitAuthIDValidityCheck()

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.

getSandTransmitAuthIDMetatype

public java.lang.String getSandTransmitAuthIDMetatype()

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

getSandTransmitErrorMessage

public java.lang.String getSandTransmitErrorMessage()

Accessor for sandTransmitErrorMessage

Specified by:

getSandTransmitErrorMessage in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)

Mutator for sandTransmitErrorMessage

Specified by:

setSandTransmitErrorMessage in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)

Generic mutator for sandTransmitErrorMessage

getSandTransmitErrorMessageFlag

public static boolean getSandTransmitErrorMessageFlag(int fieldflag)

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

getSandTransmitErrorMessageLengthNorm

public static int getSandTransmitErrorMessageLengthNorm()

Normal sandTransmitErrorMessage length is 30 characters

getSandTransmitErrorMessageLengthMax

public static int getSandTransmitErrorMessageLengthMax()

Maximum sandTransmitErrorMessage length is 70 characters

getSandTransmitErrorMessageDefaultValue

public static java.lang.String getSandTransmitErrorMessageDefaultValue()

Default value for sandTransmitErrorMessage. Returns ""

getSandTransmitErrorMessageInvalidValue

public static java.lang.String getSandTransmitErrorMessageInvalidValue()

Invalid value for sandTransmitErrorMessage. Returns null

getSandTransmitErrorMessagePrintValue

public java.lang.String getSandTransmitErrorMessagePrintValue()

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.

getSandTransmitErrorMessageFieldPrintValue

public java.lang.String getSandTransmitErrorMessageFieldPrintValue()

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

getSandTransmitErrorMessageRange

public java.lang.String getSandTransmitErrorMessageRange()

Return the range specification for this field

getSandTransmitErrorMessageValidityCheck

public java.lang.String getSandTransmitErrorMessageValidityCheck()

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.

getSandTransmitErrorMessageMetatype

public java.lang.String getSandTransmitErrorMessageMetatype()

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 org.sandev.basics.structs.SandTransmitMessage

setSandTransmitStatus

public void setSandTransmitStatus(int sandTransmitStatus)

Mutator for sandTransmitStatus

Specified by:

setSandTransmitStatus in interface org.sandev.basics.structs.SandTransmitMessage

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 Integer.MIN_VALUE

getSandTransmitStatusPrintValue

public java.lang.String getSandTransmitStatusPrintValue()

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.

getSandTransmitStatusFieldPrintValue

public java.lang.String getSandTransmitStatusFieldPrintValue()

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

getSandTransmitStatusRange

public java.lang.String getSandTransmitStatusRange()

Return the range specification for this field

getSandTransmitStatusValidityCheck

public java.lang.String getSandTransmitStatusValidityCheck()

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.

getSandTransmitStatusMetatype

public java.lang.String getSandTransmitStatusMetatype()

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

getSandTransmissionCount

public int getSandTransmissionCount()

Accessor for sandTransmissionCount

Specified by:

getSandTransmissionCount in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmissionCount

public void setSandTransmissionCount(int sandTransmissionCount)

Mutator for sandTransmissionCount

Specified by:

setSandTransmissionCount in interface org.sandev.basics.structs.SandTransmitMessage

getSandTransmissionCountFlag

public static boolean getSandTransmissionCountFlag(int fieldflag)

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

getSandTransmissionCountDefaultValue

public static int getSandTransmissionCountDefaultValue()

Default value for sandTransmissionCount. Returns 0

getSandTransmissionCountInvalidValue

public static int getSandTransmissionCountInvalidValue()

Invalid value for sandTransmissionCount. Returns Integer.MIN_VALUE

getSandTransmissionCountPrintValue

public java.lang.String getSandTransmissionCountPrintValue()

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.

getSandTransmissionCountFieldPrintValue

public java.lang.String getSandTransmissionCountFieldPrintValue()

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

getSandTransmissionCountRange

public java.lang.String getSandTransmissionCountRange()

Return the range specification for this field

getSandTransmissionCountValidityCheck

public java.lang.String getSandTransmissionCountValidityCheck()

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.

getSandTransmissionCountMetatype

public java.lang.String getSandTransmissionCountMetatype()

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

getMatchInfo

public org.sandev.basics.structs.SandAttrVal[] getMatchInfo()

Accessor for matchInfo

Specified by:

getMatchInfo in interface org.sandev.basics.structs.SandQueryMessage

setMatchInfo

public void setMatchInfo(org.sandev.basics.structs.SandAttrVal[] matchInfo)

Mutator for matchInfo

Specified by:

setMatchInfo in interface org.sandev.basics.structs.SandQueryMessage

setMatchInfo

public void setMatchInfo(java.lang.Object[] matchInfo)

Generic mutator for matchInfo

addMatchInfo

public void addMatchInfo(org.sandev.basics.structs.SandAttrVal element)

Appends a value to matchInfo

Specified by:

addMatchInfo in interface org.sandev.basics.structs.SandQueryMessage

addMatchInfo

public void addMatchInfo(org.sandev.basics.structs.SandAttrVal[] elements)

Appends an array of values to matchInfo

getMatchInfo

public org.sandev.basics.structs.SandAttrVal getMatchInfo(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setMatchInfo

public void setMatchInfo(int index,
                         org.sandev.basics.structs.SandAttrVal value)

Set the value at the index specified.

insertMatchInfo

public void insertMatchInfo(int index,
                            org.sandev.basics.structs.SandAttrVal value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeMatchInfo

public org.sandev.basics.structs.SandAttrVal removeMatchInfo(int index)

Remove the element at the specified index and return it.

removeMatchInfoValue

public boolean removeMatchInfoValue(org.sandev.basics.structs.SandAttrVal value)

Removes the given element from matchInfo. Returns true if the element was found.

clearMatchInfo

public void clearMatchInfo()

Clears all values from matchInfo

matchInfoContains

public boolean matchInfoContains(org.sandev.basics.structs.SandAttrVal val)

Returns true if matchInfo contains the specified value.

matchInfoIndexOf

public int matchInfoIndexOf(org.sandev.basics.structs.SandAttrVal val)

Return the index of the specified value in matchInfo, or -1 if not found.

sizeofMatchInfo

public int sizeofMatchInfo()

Returns the size of matchInfo. Returns -1 if matchInfo is null.

getMatchInfoFlag

public static boolean getMatchInfoFlag(int fieldflag)

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

getMatchInfoDefaultValue

public static org.sandev.basics.structs.SandAttrVal[] getMatchInfoDefaultValue()

Default value for matchInfo. Returns new SandAttrVal[0]

getMatchInfoElementInvalidValue

public static org.sandev.basics.structs.SandAttrVal getMatchInfoElementInvalidValue()

Invalid value for matchInfoelement. Returns null

getMatchInfoInvalidValue

public static org.sandev.basics.structs.SandAttrVal[] getMatchInfoInvalidValue()

Invalid value for matchInfo. Returns null

getMatchInfoRange

public java.lang.String getMatchInfoRange()

Return the range specification for this field

getMatchInfoValidityCheck

public java.lang.String getMatchInfoValidityCheck()

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.

getMatchInfoMetatype

public java.lang.String getMatchInfoMetatype()

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

getMaxReturn

public int getMaxReturn()

Accessor for maxReturn

Specified by:

getMaxReturn in interface org.sandev.basics.structs.SandQueryMessage

setMaxReturn

public void setMaxReturn(int maxReturn)

Mutator for maxReturn

Specified by:

setMaxReturn in interface org.sandev.basics.structs.SandQueryMessage

getMaxReturnFlag

public static boolean getMaxReturnFlag(int fieldflag)

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

getMaxReturnDefaultValue

public static int getMaxReturnDefaultValue()

Default value for maxReturn. Returns 200

getMaxReturnInvalidValue

public static int getMaxReturnInvalidValue()

Invalid value for maxReturn. Returns Integer.MIN_VALUE

getMaxReturnPrintValue

public java.lang.String getMaxReturnPrintValue()

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.

getMaxReturnFieldPrintValue

public java.lang.String getMaxReturnFieldPrintValue()

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

getMaxReturnRange

public java.lang.String getMaxReturnRange()

Return the range specification for this field

getMaxReturnValidityCheck

public java.lang.String getMaxReturnValidityCheck()

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.

getMaxReturnMetatype

public java.lang.String getMaxReturnMetatype()

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

getOrderBy

public java.lang.String getOrderBy()

Accessor for orderBy

Specified by:

getOrderBy in interface org.sandev.basics.structs.SandQueryMessage

setOrderBy

public void setOrderBy(java.lang.String orderBy)

Mutator for orderBy

Specified by:

setOrderBy in interface org.sandev.basics.structs.SandQueryMessage

setOrderBy

public void setOrderBy(java.lang.Object orderBy)

Generic mutator for orderBy

getOrderByFlag

public static boolean getOrderByFlag(int fieldflag)

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

getOrderByLengthNorm

public static int getOrderByLengthNorm()

Normal orderBy length is 30 characters

getOrderByLengthMax

public static int getOrderByLengthMax()

Maximum orderBy length is 70 characters

getOrderByDefaultValue

public static java.lang.String getOrderByDefaultValue()

Default value for orderBy. Returns ""

getOrderByInvalidValue

public static java.lang.String getOrderByInvalidValue()

Invalid value for orderBy. Returns null

getOrderByPrintValue

public java.lang.String getOrderByPrintValue()

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.

getOrderByFieldPrintValue

public java.lang.String getOrderByFieldPrintValue()

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

getOrderByRange

public java.lang.String getOrderByRange()

Return the range specification for this field

getOrderByValidityCheck

public java.lang.String getOrderByValidityCheck()

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.

getOrderByMetatype

public java.lang.String getOrderByMetatype()

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

getUniqueIDAfter

public long getUniqueIDAfter()

Accessor for uniqueIDAfter

Specified by:

getUniqueIDAfter in interface org.sandev.basics.structs.SandQueryMessage

setUniqueIDAfter

public void setUniqueIDAfter(long uniqueIDAfter)

Mutator for uniqueIDAfter

Specified by:

setUniqueIDAfter in interface org.sandev.basics.structs.SandQueryMessage

getUniqueIDAfterFlag

public static boolean getUniqueIDAfterFlag(int fieldflag)

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

getUniqueIDAfterDefaultValue

public static long getUniqueIDAfterDefaultValue()

Default value for uniqueIDAfter. Returns 0

getUniqueIDAfterInvalidValue

public static long getUniqueIDAfterInvalidValue()

Invalid value for uniqueIDAfter. Returns Long.MIN_VALUE

getUniqueIDAfterPrintValue

public java.lang.String getUniqueIDAfterPrintValue()

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.

getUniqueIDAfterFieldPrintValue

public java.lang.String getUniqueIDAfterFieldPrintValue()

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

getUniqueIDAfterRange

public java.lang.String getUniqueIDAfterRange()

Return the range specification for this field

getUniqueIDAfterValidityCheck

public java.lang.String getUniqueIDAfterValidityCheck()

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.

getUniqueIDAfterMetatype

public java.lang.String getUniqueIDAfterMetatype()

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

getFunction

public int getFunction()

Accessor for function

Specified by:

getFunction in interface org.sandev.basics.structs.SandQueryMessage

setFunction

public void setFunction(int function)

Mutator for function

Specified by:

setFunction in interface org.sandev.basics.structs.SandQueryMessage

functionValueToLabel

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

functionLabelToValue

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

getFunctionPrintVals

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

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.

getFunctionKeyVals

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

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.

getFunctionActualVals

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

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

functionPrint2Key

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

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

functionPrint2Actual

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

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

functionActual2Print

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

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

getFunctionEnumSummary

public static java.lang.String getFunctionEnumSummary()

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

getFunctionFlag

public static boolean getFunctionFlag(int fieldflag)

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

getFunctionDefaultValue

public static int getFunctionDefaultValue()

Default value for function. Returns 0

getFunctionInvalidValue

public static int getFunctionInvalidValue()

Invalid value for function. Returns Integer.MIN_VALUE

getFunctionPrintValue

public java.lang.String getFunctionPrintValue()

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.

Specified by:

getFunctionPrintValue in interface org.sandev.basics.structs.SandQueryMessage

getFunctionFieldPrintValue

public java.lang.String getFunctionFieldPrintValue()

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

getFunctionRange

public java.lang.String getFunctionRange()

Return the range specification for this field

getFunctionValidityCheck

public java.lang.String getFunctionValidityCheck()

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.

getFunctionMetatype

public java.lang.String getFunctionMetatype()

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

getOperationFields

public java.lang.String getOperationFields()

Accessor for operationFields

Specified by:

getOperationFields in interface org.sandev.basics.structs.SandQueryMessage

setOperationFields

public void setOperationFields(java.lang.String operationFields)

Mutator for operationFields

Specified by:

setOperationFields in interface org.sandev.basics.structs.SandQueryMessage

setOperationFields

public void setOperationFields(java.lang.Object operationFields)

Generic mutator for operationFields

getOperationFieldsFlag

public static boolean getOperationFieldsFlag(int fieldflag)

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

getOperationFieldsLengthNorm

public static int getOperationFieldsLengthNorm()

Normal operationFields length is 30 characters

getOperationFieldsLengthMax

public static int getOperationFieldsLengthMax()

Maximum operationFields length is 70 characters

getOperationFieldsDefaultValue

public static java.lang.String getOperationFieldsDefaultValue()

Default value for operationFields. Returns ""

getOperationFieldsInvalidValue

public static java.lang.String getOperationFieldsInvalidValue()

Invalid value for operationFields. Returns null

getOperationFieldsPrintValue

public java.lang.String getOperationFieldsPr