HeapAttributesCollection

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 HeapAttributesCollection

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

All Implemented Interfaces:: org.sandev.basics.structs.SandCollectionMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandTransmitMessage, org.sandev.basics.structs.SandVerbMessage

public class HeapAttributesCollection
extends java.lang.Object
implements org.sandev.basics.structs.SandCollectionMessage
extends java.lang.Object
implements org.sandev.basics.structs.SandCollectionMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.HeapAttributesStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:16 PM

Field Summary
`protected boolean`	`complete` support for SandCollectionMessage interface
`protected HeapAttributes[]`	`heapAttributeses` actual element array
`protected org.sandev.basics.structs.SandAttrVal[]`	`pagination` support for SandCollectionMessage interface
`protected java.lang.String`	`queryResult` support for SandCollectionMessage interface
`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 int`	`total` support for SandCollectionMessage interface

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
`HeapAttributesCollection()` Default constructor calls init.

Method Summary
`void`	`addElement(org.sandev.basics.structs.SandInstanceMessage elem)` Specified by SandCollectionMessage interface
`void`	`addElements(org.sandev.basics.structs.SandInstanceMessage[] elems)` Specified by SandCollectionMessage interface
`void`	`addHeapAttributeses(HeapAttributes element)` Appends a value to heapAttributeses
`void`	`addHeapAttributeses(HeapAttributes[] elements)` Appends an array of values to heapAttributeses
`void`	`addPagination(org.sandev.basics.structs.SandAttrVal element)` Appends a value to pagination
`void`	`addPagination(org.sandev.basics.structs.SandAttrVal[] elements)` Appends an array of values to pagination
`void`	`clearHeapAttributeses()` Clears all values from heapAttributeses
`void`	`clearPagination()` Clears all values from pagination
`HeapAttributesCollection`	`cloneHeapAttributesCollection()` Clone the collection returning a new copy of the message with a new array containing the same references.
`boolean`	`containsID(long id)` Return true if the collection contains an element with the specified uniqueID, false otherwise
`boolean`	`fieldHasFlag(java.lang.String fieldname, int fieldflag)` Return true if the named field declares the indicated flag, false otherwise.
`int`	`getBaseMemoryUse()` Return the base memory use for this object.
`org.sandev.basics.structs.SandCollectionMessage`	`getCollectionMessage()` Returns a new HeapAttributesCollection instance
`boolean`	`getComplete()` Accessor for complete
`static boolean`	`getCompleteDefaultValue()` Default value for complete.
`java.lang.String`	`getCompleteFieldPrintValue()` Return the print name of the complete field.
`static boolean`	`getCompleteFlag(int fieldflag)` Field flag accessor.
`java.lang.String`	`getCompleteMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getCompletePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getCompleteRange()` Return the range specification for this field
`java.lang.String`	`getCompleteValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`long[]`	`getContentIDs()` Return an array of the uniqueIDs in this collection.
`org.sandev.basics.structs.SandInstanceMessage[]`	`getElements()` Specified by SandCollectionMessage interface
`HeapAttributes[]`	`getHeapAttributeses()` Accessor for heapAttributeses.
`HeapAttributes`	`getHeapAttributeses(int index)` Returns the element at the specified index.
`static HeapAttributes[]`	`getHeapAttributesesDefaultValue()` Default value for heapAttributeses.
`static HeapAttributes`	`getHeapAttributesesElementInvalidValue()` Invalid value for heapAttributeseselement.
`java.lang.String`	`getHeapAttributesesFieldPrintValue()` Return the print name of the heapAttributeses field.
`static boolean`	`getHeapAttributesesFlag(int fieldflag)` Field flag accessor.
`static HeapAttributes[]`	`getHeapAttributesesInvalidValue()` Invalid value for heapAttributeses.
`java.lang.String`	`getHeapAttributesesMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getHeapAttributesesPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getHeapAttributesesRange()` Return the range specification for this field
`java.lang.String`	`getHeapAttributesesValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.structs.SandAttrVal[]`	`getPagination()` Accessor for pagination.
`org.sandev.basics.structs.SandAttrVal`	`getPagination(int index)` Returns the element at the specified index.
`static org.sandev.basics.structs.SandAttrVal[]`	`getPaginationDefaultValue()` Default value for pagination.
`static org.sandev.basics.structs.SandAttrVal`	`getPaginationElementInvalidValue()` Invalid value for paginationelement.
`java.lang.String`	`getPaginationFieldPrintValue()` Return the print name of the pagination field.
`static boolean`	`getPaginationFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.structs.SandAttrVal[]`	`getPaginationInvalidValue()` Invalid value for pagination.
`java.lang.String`	`getPaginationMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`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 HeapAttributesQuery instance
`java.lang.String`	`getQueryResult()` Accessor for queryResult
`static java.lang.String`	`getQueryResultDefaultValue()` Default value for queryResult.
`java.lang.String`	`getQueryResultFieldPrintValue()` Return the print name of the queryResult field.
`static boolean`	`getQueryResultFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getQueryResultInvalidValue()` Invalid value for queryResult.
`static int`	`getQueryResultLengthMax()` Maximum queryResult length is 70 characters
`static int`	`getQueryResultLengthNorm()` Normal queryResult length is 30 characters
`java.lang.String`	`getQueryResultMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getQueryResultPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getQueryResultRange()` Return the range specification for this field
`java.lang.String`	`getQueryResultValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`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 HeapAttributes instance
`int`	`getTotal()` Accessor for total
`static int`	`getTotalDefaultValue()` Default value for total.
`java.lang.String`	`getTotalFieldPrintValue()` Return the print name of the total field.
`static boolean`	`getTotalFlag(int fieldflag)` Field flag accessor.
`static int`	`getTotalInvalidValue()` Invalid value for total.
`java.lang.String`	`getTotalMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getTotalPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getTotalRange()` Return the range specification for this field
`java.lang.String`	`getTotalValidityCheck()` 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 HeapAttributesUpdate instance
`boolean`	`heapAttributesesContains(HeapAttributes val)` Returns true if heapAttributeses contains the specified value.
`int`	`heapAttributesesIndexOf(HeapAttributes val)` Return the index of the specified value in heapAttributeses, or -1 if not found.
`void`	`init()` Initialize all fields to their default values
`void`	`insertHeapAttributeses(int index, HeapAttributes value)` Insert the specified element at the specified index.
`void`	`insertPagination(int index, org.sandev.basics.structs.SandAttrVal value)` Insert the specified element at the specified index.
`boolean`	`isComplete()` Specified by SandCollectionMessage interface
`boolean`	`isEquivalent(org.sandev.basics.structs.SandMessage sm)` Declared field equivalence check as specified by the SandMessage interface.
`boolean`	`paginationContains(org.sandev.basics.structs.SandAttrVal val)` Returns true if pagination contains the specified value.
`int`	`paginationIndexOf(org.sandev.basics.structs.SandAttrVal val)` Return the index of the specified value in pagination, or -1 if not found.
`boolean`	`removeElement(org.sandev.basics.structs.SandInstanceMessage elem)` Specified by SandCollectionMessage interface
`HeapAttributes`	`removeHeapAttributeses(int index)` Remove the element at the specified index and return it.
`boolean`	`removeHeapAttributesesValue(HeapAttributes value)` Removes the given element from heapAttributeses.
`org.sandev.basics.structs.SandAttrVal`	`removePagination(int index)` Remove the element at the specified index and return it.
`boolean`	`removePaginationValue(org.sandev.basics.structs.SandAttrVal value)` Removes the given element from pagination.
`void`	`setComplete(boolean complete)` Mutator for complete
`void`	`setElements(java.lang.Object[] elements)` Specified by SandCollectionMessage interface
`void`	`setHeapAttributeses(HeapAttributes[] heapAttributeses)` Mutator for heapAttributeses
`void`	`setHeapAttributeses(int index, HeapAttributes value)` Set the value at the index specified.
`void`	`setHeapAttributeses(java.lang.Object[] heapAttributeses)` Generic mutator for heapAttributeses
`void`	`setPagination(int index, org.sandev.basics.structs.SandAttrVal value)` Set the value at the index specified.
`void`	`setPagination(java.lang.Object[] pagination)` Generic mutator for pagination
`void`	`setPagination(org.sandev.basics.structs.SandAttrVal[] pagination)` Mutator for pagination
`void`	`setQueryResult(java.lang.Object queryResult)` Generic mutator for queryResult
`void`	`setQueryResult(java.lang.String queryResult)` Mutator for queryResult
`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`	`setTotal(int total)` Mutator for total
`int`	`sizeofHeapAttributeses()` Returns the size of heapAttributeses.
`int`	`sizeofPagination()` Returns the size of pagination.

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

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

complete

protected boolean complete

support for SandCollectionMessage interface

heapAttributeses

protected HeapAttributes[] heapAttributeses

actual element array

queryResult

protected java.lang.String queryResult

support for SandCollectionMessage interface

total

protected int total

support for SandCollectionMessage interface

pagination

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

support for SandCollectionMessage interface

Constructor Detail

HeapAttributesCollection

public HeapAttributesCollection()

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

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

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

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

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 getSandTransmitStatusInvalidValue()

Invalid value for sandTransmitStatus. Returns Integer.MIN_VALUE

getSandTransmitStatusPrintValue

public java.lang.String getSandTransmitStatusPrintValue()

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

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

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

getSandTransmissionCountMetatype

public java.lang.String getSandTransmissionCountMetatype()

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

getSandTransmissionLocale

public java.util.Locale getSandTransmissionLocale()

Accessor for sandTransmissionLocale

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

setSandTransmissionLocale

public void setSandTransmissionLocale(java.util.Locale sandTransmissionLocale)

Mutator for sandTransmissionLocale

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

setSandTransmissionLocale

public void setSandTransmissionLocale(java.lang.Object sandTransmissionLocale)

Generic mutator for sandTransmissionLocale

getSandTransmissionLocaleFlag

public static boolean getSandTransmissionLocaleFlag(int fieldflag)

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

getSandTransmissionLocaleDefaultValue

public static java.util.Locale getSandTransmissionLocaleDefaultValue()

Default value for sandTransmissionLocale. Returns null

getSandTransmissionLocaleInvalidValue

public static java.util.Locale getSandTransmissionLocaleInvalidValue()

Invalid value for sandTransmissionLocale. Returns null

getSandTransmissionLocalePrintValue

public java.lang.String getSandTransmissionLocalePrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getSandTransmissionLocaleFieldPrintValue

public java.lang.String getSandTransmissionLocaleFieldPrintValue()

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

getSandTransmissionLocaleRange

public java.lang.String getSandTransmissionLocaleRange()

Return the range specification for this field

getSandTransmissionLocaleValidityCheck

public java.lang.String getSandTransmissionLocaleValidityCheck()

getSandTransmissionLocaleMetatype

public java.lang.String getSandTransmissionLocaleMetatype()

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

getComplete

public boolean getComplete()

Accessor for complete

setComplete

public void setComplete(boolean complete)

Mutator for complete

Specified by:: setComplete in interface org.sandev.basics.structs.SandCollectionMessage

getCompleteFlag

public static boolean getCompleteFlag(int fieldflag)

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

getCompleteDefaultValue

public static boolean getCompleteDefaultValue()

Default value for complete. Returns false

getCompletePrintValue

public java.lang.String getCompletePrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getCompleteFieldPrintValue

public java.lang.String getCompleteFieldPrintValue()

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

getCompleteRange

public java.lang.String getCompleteRange()

Return the range specification for this field

getCompleteValidityCheck

public java.lang.String getCompleteValidityCheck()

getCompleteMetatype

public java.lang.String getCompleteMetatype()

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

getHeapAttributeses

public HeapAttributes[] getHeapAttributeses()

Accessor for heapAttributeses. The returned value may or may not be the actual data member. Always write back a changed array using setHeapAttributeses.

setHeapAttributeses

public void setHeapAttributeses(HeapAttributes[] heapAttributeses)

Mutator for heapAttributeses

setHeapAttributeses

public void setHeapAttributeses(java.lang.Object[] heapAttributeses)

Generic mutator for heapAttributeses

addHeapAttributeses

public void addHeapAttributeses(HeapAttributes element)

Appends a value to heapAttributeses

addHeapAttributeses

public void addHeapAttributeses(HeapAttributes[] elements)

Appends an array of values to heapAttributeses

getHeapAttributeses

public HeapAttributes getHeapAttributeses(int index)

Returns the element at the specified index. Returns null if heapAttributeses is null or smaller than index.

setHeapAttributeses

public void setHeapAttributeses(int index,
                                HeapAttributes value)

Set the value at the index specified.

insertHeapAttributeses

public void insertHeapAttributeses(int index,
                                   HeapAttributes 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.

removeHeapAttributeses

public HeapAttributes removeHeapAttributeses(int index)

Remove the element at the specified index and return it.

removeHeapAttributesesValue

public boolean removeHeapAttributesesValue(HeapAttributes value)

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

clearHeapAttributeses

public void clearHeapAttributeses()

Clears all values from heapAttributeses

heapAttributesesContains

public boolean heapAttributesesContains(HeapAttributes val)

Returns true if heapAttributeses contains the specified value.

heapAttributesesIndexOf

public int heapAttributesesIndexOf(HeapAttributes val)

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

sizeofHeapAttributeses

public int sizeofHeapAttributeses()

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

getHeapAttributesesFlag

public static boolean getHeapAttributesesFlag(int fieldflag)

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

getHeapAttributesesDefaultValue

public static HeapAttributes[] getHeapAttributesesDefaultValue()

Default value for heapAttributeses. Returns new HeapAttributes[0]

getHeapAttributesesElementInvalidValue

public static

org.sandev.TaskHeap.sandmessages Class HeapAttributesCollection

sandTransmitAuthID

sandTransmitErrorMessage

sandTransmitErrorCode

sandTransmitStatus

sandTransmissionCount

sandTransmissionLocale

complete

heapAttributeses

queryResult

total

pagination

HeapAttributesCollection

fieldHasFlag

getSandTransmitAuthID

setSandTransmitAuthID

getSandTransmitAuthIDFlag

getSandTransmitAuthIDDefaultValue

getSandTransmitAuthIDInvalidValue

getSandTransmitAuthIDPrintValue

getSandTransmitAuthIDFieldPrintValue

getSandTransmitAuthIDRange

getSandTransmitAuthIDValidityCheck

getSandTransmitAuthIDMetatype

getSandTransmitErrorMessage

setSandTransmitErrorMessage

setSandTransmitErrorMessage

getSandTransmitErrorMessageFlag

getSandTransmitErrorMessageLengthNorm

getSandTransmitErrorMessageLengthMax

getSandTransmitErrorMessageDefaultValue

getSandTransmitErrorMessageInvalidValue

getSandTransmitErrorMessagePrintValue

getSandTransmitErrorMessageFieldPrintValue

getSandTransmitErrorMessageRange

getSandTransmitErrorMessageValidityCheck

getSandTransmitErrorMessageMetatype

getSandTransmitErrorCode

setSandTransmitErrorCode

setSandTransmitErrorCode

setSandTransmitError

getSandTransmitErrorCodeFlag

getSandTransmitErrorCodeLengthNorm

getSandTransmitErrorCodeLengthMax

getSandTransmitErrorCodeDefaultValue

getSandTransmitErrorCodeInvalidValue

getSandTransmitErrorCodePrintValue

getSandTransmitErrorCodeFieldPrintValue

getSandTransmitErrorCodeRange

getSandTransmitErrorCodeValidityCheck

getSandTransmitErrorCodeMetatype

getSandTransmitStatus

setSandTransmitStatus

getSandTransmitStatusFlag

getSandTransmitStatusDefaultValue

getSandTransmitStatusInvalidValue

getSandTransmitStatusPrintValue

getSandTransmitStatusFieldPrintValue

getSandTransmitStatusRange

getSandTransmitStatusValidityCheck

getSandTransmitStatusMetatype

getSandTransmissionCount

setSandTransmissionCount

getSandTransmissionCountFlag

getSandTransmissionCountDefaultValue

getSandTransmissionCountInvalidValue

getSandTransmissionCountPrintValue

getSandTransmissionCountFieldPrintValue

getSandTransmissionCountRange

getSandTransmissionCountValidityCheck

getSandTransmissionCountMetatype

getSandTransmissionLocale

setSandTransmissionLocale

setSandTransmissionLocale

getSandTransmissionLocaleFlag

getSandTransmissionLocaleDefaultValue

getSandTransmissionLocaleInvalidValue

getSandTransmissionLocalePrintValue

getSandTransmissionLocaleFieldPrintValue

getSandTransmissionLocaleRange

org.sandev.TaskHeap.sandmessages
Class HeapAttributesCollection