Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.sandev.TaskHeap.sandmessages
Class RoleQuery

java.lang.Object
  extended by org.sandev.TaskHeap.sandmessages.RoleQuery
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 RoleQuery
extends java.lang.Object
implements org.sandev.basics.structs.SandQueryMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.RoleStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:16 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 orderSense
          support for SandQueryMessage interface
protected  int pagination
          support for SandQueryMessage interface
static int PAGINATION_ALL
          Possible value for pagination
static int PAGINATION_NONE
          Possible value for pagination
static int PAGINATION_TOTALONLY
          Possible value for pagination
protected  int sandTransmissionCount
          support for SandTransmitMessage interface
protected  java.util.Locale sandTransmissionLocale
          support for SandTransmitMessage interface
protected  long sandTransmitAuthID
          support for SandTransmitMessage interface
protected  java.lang.String sandTransmitErrorCode
          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_INVALID_OPERATION_FIELDS, APPERROR_NO_OPERANDS_SPECIFIED, EXPRESSION_OPERATOR, FUNCTION_UIDS, ORDER_ASCENDING, ORDER_DESCENDING, ORDER_UNSPECIFIED, PAGE_ALL, PAGE_NONE, PAGE_TOTALONLY
 
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
RoleQuery()
          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 addMatchInfo(java.lang.String attr, java.lang.String val)
          Convenience shorthand method for adding a SandAttrVal to the match info.
 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 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)
           
 int getBaseMemoryUse()
          Return the base memory use for this object.
 org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()
          Returns a new RoleCollection 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.
 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 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.
 int getOrderSense()
          Accessor for orderSense
static int getOrderSenseDefaultValue()
          Default value for orderSense.
 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.
 java.lang.String getOrderSenseMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 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.
 int getPagination()
          Accessor for pagination
static java.lang.String[] getPaginationActualVals()
          Return an array of the possible values for this field as Strings.
static int getPaginationDefaultValue()
          Default value for pagination.
static java.lang.String getPaginationEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getPaginationFieldPrintValue()
          Return the print name of the pagination field.
static boolean getPaginationFlag(int fieldflag)
          Field flag accessor.
static int getPaginationInvalidValue()
          Invalid value for pagination.
static java.lang.String[] getPaginationKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getPaginationMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getPaginationPrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getPaginationPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getPaginationRange()
          Return the range specification for this field
 java.lang.String getPaginationValidityCheck()
          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 RoleQuery 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.
 java.util.Locale getSandTransmissionLocale()
          Accessor for sandTransmissionLocale
static java.util.Locale getSandTransmissionLocaleDefaultValue()
          Default value for sandTransmissionLocale.
 java.lang.String getSandTransmissionLocaleFieldPrintValue()
          Return the print name of the sandTransmissionLocale field.
static boolean getSandTransmissionLocaleFlag(int fieldflag)
          Field flag accessor.
static java.util.Locale getSandTransmissionLocaleInvalidValue()
          Invalid value for sandTransmissionLocale.
 java.lang.String getSandTransmissionLocaleMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSandTransmissionLocalePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSandTransmissionLocaleRange()
          Return the range specification for this field
 java.lang.String getSandTransmissionLocaleValidityCheck()
          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 getSandTransmitErrorCode()
          Accessor for sandTransmitErrorCode
static java.lang.String getSandTransmitErrorCodeDefaultValue()
          Default value for sandTransmitErrorCode.
 java.lang.String getSandTransmitErrorCodeFieldPrintValue()
          Return the print name of the sandTransmitErrorCode field.
static boolean getSandTransmitErrorCodeFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getSandTransmitErrorCodeInvalidValue()
          Invalid value for sandTransmitErrorCode.
static int getSandTransmitErrorCodeLengthMax()
          Maximum sandTransmitErrorCode length is 70 characters
static int getSandTransmitErrorCodeLengthNorm()
          Normal sandTransmitErrorCode length is 30 characters
 java.lang.String getSandTransmitErrorCodeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSandTransmitErrorCodePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSandTransmitErrorCodeRange()
          Return the range specification for this field
 java.lang.String getSandTransmitErrorCodeValidityCheck()
          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 Role 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 RoleUpdate 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(java.lang.Object msg)
          As specified by the SandQueryMessage interface.
 boolean matchesOn(java.lang.String field)
          Return true if this query specifies a match for the given field name, false otherwise.
 boolean matchesOn(java.lang.String field, java.lang.String value)
          Return true if this query specifies a match for the given field with the given value, false otherwise.
 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.
static java.lang.String paginationActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int paginationLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static int paginationLabelToValueStatic(java.lang.String label)
           
static java.lang.String paginationPrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String paginationPrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String paginationValueToLabel(int val)
          Given a value, return the declared label for it.
static java.lang.String paginationValueToLabelStatic(int val)
           
 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 setOrderSense(int orderSense)
          Mutator for orderSense
 void setPagination(int pagination)
          Mutator for pagination
 void setSandTransmissionCount(int sandTransmissionCount)
          Mutator for sandTransmissionCount
 void setSandTransmissionLocale(java.util.Locale sandTransmissionLocale)
          Mutator for sandTransmissionLocale
 void setSandTransmissionLocale(java.lang.Object sandTransmissionLocale)
          Generic mutator for sandTransmissionLocale
 void setSandTransmitAuthID(long sandTransmitAuthID)
          Mutator for sandTransmitAuthID
 void setSandTransmitError(java.lang.String code, java.lang.String errText)
          Sets both the code and the error in a single method.
 void setSandTransmitErrorCode(java.lang.Object sandTransmitErrorCode)
          Generic mutator for sandTransmitErrorCode
 void setSandTransmitErrorCode(java.lang.String sandTransmitErrorCode)
          Mutator for sandTransmitErrorCode
 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 toString()
          Return a string representation of this object.
 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, wait, wait, wait
 

Field Detail

sandTransmitAuthID

protected long sandTransmitAuthID
support for SandTransmitMessage interface

sandTransmitErrorMessage

protected java.lang.String sandTransmitErrorMessage
support for SandTransmitMessage interface

sandTransmitErrorCode

protected java.lang.String sandTransmitErrorCode
support for SandTransmitMessage interface

sandTransmitStatus

protected int sandTransmitStatus
support for SandTransmitMessage interface

sandTransmissionCount

protected int sandTransmissionCount
support for SandTransmitMessage interface

sandTransmissionLocale

protected java.util.Locale sandTransmissionLocale
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

orderSense

protected int orderSense
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

pagination

protected int pagination
support for SandQueryMessage interface

PAGINATION_NONE

public static final int PAGINATION_NONE
Possible value for pagination

See Also:
Constant Field Values

PAGINATION_TOTALONLY

public static final int PAGINATION_TOTALONLY
Possible value for pagination

See Also:
Constant Field Values

PAGINATION_ALL

public static final int PAGINATION_ALL
Possible value for pagination

See Also:
Constant Field Values
Constructor Detail

RoleQuery

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

getSandTransmitErrorCode

public java.lang.String getSandTransmitErrorCode()
Accessor for sandTransmitErrorCode

Specified by:
getSandTransmitErrorCode in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitErrorCode

public void setSandTransmitErrorCode(java.lang.String sandTransmitErrorCode)
Mutator for sandTransmitErrorCode

Specified by:
setSandTransmitErrorCode in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitErrorCode

public void setSandTransmitErrorCode(java.lang.Object sandTransmitErrorCode)
Generic mutator for sandTransmitErrorCode

setSandTransmitError

public void setSandTransmitError(java.lang.String code,
                                 java.lang.String errText)
Sets both the code and the error in a single method.

Specified by:
setSandTransmitError in interface org.sandev.basics.structs.SandTransmitMessage

getSandTransmitErrorCodeFlag

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

getSandTransmitErrorCodeLengthNorm

public static int getSandTransmitErrorCodeLengthNorm()
Normal sandTransmitErrorCode length is 30 characters

getSandTransmitErrorCodeLengthMax

public static int getSandTransmitErrorCodeLengthMax()
Maximum sandTransmitErrorCode length is 70 characters

getSandTransmitErrorCodeDefaultValue

public static java.lang.String getSandTransmitErrorCodeDefaultValue()
Default value for sandTransmitErrorCode. Returns ""

getSandTransmitErrorCodeInvalidValue

public static java.lang.String getSandTransmitErrorCodeInvalidValue()
Invalid value for sandTransmitErrorCode. Returns null

getSandTransmitErrorCodePrintValue

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

getSandTransmitErrorCodeFieldPrintValue

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

getSandTransmitErrorCodeRange

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

getSandTransmitErrorCodeValidityCheck

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

getSandTransmitErrorCodeMetatype

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