org.sandev.basics.sandmessages
Class BaseUserCollection

java.lang.Object
  org.sandev.basics.sandmessages.BaseUserCollection

All Implemented Interfaces:

SandCollectionMessage, SandMessage, SandTransmitMessage, SandVerbMessage

public class BaseUserCollection

extends java.lang.Object

implements SandCollectionMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.BaseUserStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:50 PM

Field Summary

protected BaseUser[]	baseUsers actual element array
protected boolean	complete support for SandCollectionMessage interface
protected java.lang.String	queryResult support for SandCollectionMessage 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

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

BaseUserCollection()
Default constructor calls init.

Method Summary

void	addBaseUsers(BaseUser element) Appends a value to baseUsers
void	addBaseUsers(BaseUser[] elements) Appends an array of values to baseUsers
void	addElement(SandInstanceMessage elem) Specified by SandCollectionMessage interface
boolean	baseUsersContains(BaseUser val) Returns true if baseUsers contains the specified value.
int	baseUsersIndexOf(BaseUser val) Return the index of the specified value in baseUsers, or -1 if not found.
void	clearBaseUsers() Clears all values from baseUsers
BaseUserCollection	cloneBaseUserCollection() Clone the collection returning a new copy of the message with a new array containing the same references.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
BaseUser[]	getBaseUsers() Accessor for baseUsers
BaseUser	getBaseUsers(int index) Returns the element at the specified index.
static BaseUser[]	getBaseUsersDefaultValue() Default value for baseUsers.
static BaseUser	getBaseUsersElementInvalidValue() Invalid value for baseUserselement.
static boolean	getBaseUsersFlag(int fieldflag) Field flag accessor.
static BaseUser[]	getBaseUsersInvalidValue() Invalid value for baseUsers.
java.lang.String	getBaseUsersMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getBaseUsersRange() Return the range specification for this field
java.lang.String	getBaseUsersValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandCollectionMessage	getCollectionMessage() Returns a new BaseUserCollection 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.
SandInstanceMessage[]	getElements() Specified by SandCollectionMessage interface
SandQueryMessage	getQueryMessage() Returns a new BaseUserQuery 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.
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.
SandStructMessage	getStructMessage() Returns a new BaseUser instance
SandUpdateMessage	getUpdateMessage() Returns a new BaseUserUpdate instance
void	init() Initialize all fields to their default values
void	insertBaseUsers(int index, BaseUser value) Insert the specified element at the specified index.
boolean	isComplete() Specified by SandCollectionMessage interface
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
BaseUser	removeBaseUsers(int index) Remove the element at the specified index and return it.
boolean	removeBaseUsersValue(BaseUser value) Removes the given element from baseUsers.
boolean	removeElement(SandInstanceMessage elem) Specified by SandCollectionMessage interface
void	setBaseUsers(BaseUser[] baseUsers) Mutator for baseUsers
void	setBaseUsers(int index, BaseUser value) Set the value at the index specified.
void	setBaseUsers(java.lang.Object[] baseUsers) Generic mutator for baseUsers
void	setComplete(boolean complete) Mutator for complete
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	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
int	sizeofBaseUsers() Returns the size of baseUsers.

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

complete

protected boolean complete

support for SandCollectionMessage interface

baseUsers

protected BaseUser[] baseUsers

actual element array

queryResult

protected java.lang.String queryResult

support for SandCollectionMessage interface

Constructor Detail

BaseUserCollection

public BaseUserCollection()

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 SandTransmitMessage

setSandTransmitAuthID

public void setSandTransmitAuthID(long sandTransmitAuthID)

Mutator for sandTransmitAuthID

Specified by:

setSandTransmitAuthID in interface 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 SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)

Mutator for sandTransmitErrorMessage

Specified by:

setSandTransmitErrorMessage in interface 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 SandTransmitMessage

setSandTransmitStatus

public void setSandTransmitStatus(int sandTransmitStatus)

Mutator for sandTransmitStatus

Specified by:

setSandTransmitStatus in interface 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 SandTransmitMessage

setSandTransmissionCount

public void setSandTransmissionCount(int sandTransmissionCount)

Mutator for sandTransmissionCount

Specified by:

setSandTransmissionCount in interface 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.

getComplete

public boolean getComplete()

Accessor for complete

setComplete

public void setComplete(boolean complete)

Mutator for complete

Specified by:

setComplete in interface 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()

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.

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

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.

getCompleteMetatype

public java.lang.String getCompleteMetatype()

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

getBaseUsers

public BaseUser[] getBaseUsers()

Accessor for baseUsers

setBaseUsers

public void setBaseUsers(BaseUser[] baseUsers)

Mutator for baseUsers

setBaseUsers

public void setBaseUsers(java.lang.Object[] baseUsers)

Generic mutator for baseUsers

addBaseUsers

public void addBaseUsers(BaseUser element)

Appends a value to baseUsers

addBaseUsers

public void addBaseUsers(BaseUser[] elements)

Appends an array of values to baseUsers

getBaseUsers

public BaseUser getBaseUsers(int index)

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

setBaseUsers

public void setBaseUsers(int index,
                         BaseUser value)

Set the value at the index specified.

insertBaseUsers

public void insertBaseUsers(int index,
                            BaseUser 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.

removeBaseUsers

public BaseUser removeBaseUsers(int index)

Remove the element at the specified index and return it.

removeBaseUsersValue

public boolean removeBaseUsersValue(BaseUser value)

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

clearBaseUsers

public void clearBaseUsers()

Clears all values from baseUsers

baseUsersContains

public boolean baseUsersContains(BaseUser val)

Returns true if baseUsers contains the specified value.

baseUsersIndexOf

public int baseUsersIndexOf(BaseUser val)

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

sizeofBaseUsers

public int sizeofBaseUsers()

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

getBaseUsersFlag

public static boolean getBaseUsersFlag(int fieldflag)

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

getBaseUsersDefaultValue

public static BaseUser[] getBaseUsersDefaultValue()

Default value for baseUsers. Returns new BaseUser[0]

getBaseUsersElementInvalidValue

public static BaseUser getBaseUsersElementInvalidValue()

Invalid value for baseUserselement. Returns null

getBaseUsersInvalidValue

public static BaseUser[] getBaseUsersInvalidValue()

Invalid value for baseUsers. Returns null

getBaseUsersRange

public java.lang.String getBaseUsersRange()

Return the range specification for this field

getBaseUsersValidityCheck

public java.lang.String getBaseUsersValidityCheck()

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.

getBaseUsersMetatype

public java.lang.String getBaseUsersMetatype()

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

getQueryResult

public java.lang.String getQueryResult()

Accessor for queryResult

Specified by:

getQueryResult in interface SandCollectionMessage

setQueryResult

public void setQueryResult(java.lang.String queryResult)

Mutator for queryResult

Specified by:

setQueryResult in interface SandCollectionMessage

setQueryResult

public void setQueryResult(java.lang.Object queryResult)

Generic mutator for queryResult

getQueryResultFlag

public static boolean getQueryResultFlag(int fieldflag)

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

getQueryResultLengthNorm

public static int getQueryResultLengthNorm()

Normal queryResult length is 30 characters

getQueryResultLengthMax

public static int getQueryResultLengthMax()

Maximum queryResult length is 70 characters

getQueryResultDefaultValue

public static java.lang.String getQueryResultDefaultValue()

Default value for queryResult. Returns ""

getQueryResultInvalidValue

public static java.lang.String getQueryResultInvalidValue()

Invalid value for queryResult. Returns null

getQueryResultPrintValue

public java.lang.String getQueryResultPrintValue()

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.

getQueryResultFieldPrintValue

public java.lang.String getQueryResultFieldPrintValue()

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

getQueryResultRange

public java.lang.String getQueryResultRange()

Return the range specification for this field

getQueryResultValidityCheck

public java.lang.String getQueryResultValidityCheck()

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.

getQueryResultMetatype

public java.lang.String getQueryResultMetatype()

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

init

public void init()

Initialize all fields to their default values

getElements

public SandInstanceMessage[] getElements()

Specified by SandCollectionMessage interface

Specified by:

getElements in interface SandCollectionMessage

addElement

public void addElement(SandInstanceMessage elem)

Specified by SandCollectionMessage interface

Specified by:

addElement in interface SandCollectionMessage

removeElement

public boolean removeElement(SandInstanceMessage elem)

Specified by SandCollectionMessage interface

Specified by:

removeElement in interface SandCollectionMessage

isComplete

public boolean isComplete()

Specified by SandCollectionMessage interface

Specified by:

isComplete in interface SandCollectionMessage

cloneBaseUserCollection

public BaseUserCollection cloneBaseUserCollection()

Clone the collection returning a new copy of the message with a new array containing the same references.

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:

getShortName in interface SandMessage

getQueryMessage

public SandQueryMessage getQueryMessage()

Returns a new BaseUserQuery instance

Specified by:

getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()

Returns a new BaseUserCollection instance

Specified by:

getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()

Returns a new BaseUserUpdate instance

Specified by:

getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new BaseUser instance

Specified by:

getStructMessage in interface SandMessage

isEquivalent

public boolean isEquivalent(SandMessage sm)

Declared field equivalence check as specified by the SandMessage interface. String values are trimmed before comparison because conversions may occasionally result in trailing whitespace, which should not cause equivalence comparisons to fail. Comparisons are case insensitive since that corresponds to what most people expect, and how most databases work.

Specified by:

isEquivalent in interface SandMessage