org.sandev.basics.sandmessages
Class BaseUserEmailCollection

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

All Implemented Interfaces:

SandCollectionMessage, SandMessage, SandTransmitMessage, SandVerbMessage

public class BaseUserEmailCollection
extends java.lang.Object
implements SandCollectionMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.BaseUserEmailStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jun 15, 2007 11:40:44 PM

Field Summary

protected BaseUserEmail[]	baseUserEmails 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 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

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

BaseUserEmailCollection()
Default constructor calls init.

Method Summary

void	addBaseUserEmails(BaseUserEmail element) Appends a value to baseUserEmails
void	addBaseUserEmails(BaseUserEmail[] elements) Appends an array of values to baseUserEmails
void	addElement(SandInstanceMessage elem) Specified by SandCollectionMessage interface
boolean	baseUserEmailsContains(BaseUserEmail val) Returns true if baseUserEmails contains the specified value.
int	baseUserEmailsIndexOf(BaseUserEmail val) Return the index of the specified value in baseUserEmails, or -1 if not found.
void	clearBaseUserEmails() Clears all values from baseUserEmails
BaseUserEmailCollection	cloneBaseUserEmailCollection() 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.
BaseUserEmail[]	getBaseUserEmails() Accessor for baseUserEmails.
BaseUserEmail	getBaseUserEmails(int index) Returns the element at the specified index.
static BaseUserEmail[]	getBaseUserEmailsDefaultValue() Default value for baseUserEmails.
static BaseUserEmail	getBaseUserEmailsElementInvalidValue() Invalid value for baseUserEmailselement.
static boolean	getBaseUserEmailsFlag(int fieldflag) Field flag accessor.
static BaseUserEmail[]	getBaseUserEmailsInvalidValue() Invalid value for baseUserEmails.
java.lang.String	getBaseUserEmailsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getBaseUserEmailsRange() Return the range specification for this field
java.lang.String	getBaseUserEmailsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandCollectionMessage	getCollectionMessage() Returns a new BaseUserEmailCollection 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 BaseUserEmailQuery 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.
SandStructMessage	getStructMessage() Returns a new BaseUserEmail instance
SandUpdateMessage	getUpdateMessage() Returns a new BaseUserEmailUpdate instance
void	init() Initialize all fields to their default values
void	insertBaseUserEmails(int index, BaseUserEmail 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.
BaseUserEmail	removeBaseUserEmails(int index) Remove the element at the specified index and return it.
boolean	removeBaseUserEmailsValue(BaseUserEmail value) Removes the given element from baseUserEmails.
boolean	removeElement(SandInstanceMessage elem) Specified by SandCollectionMessage interface
void	setBaseUserEmails(BaseUserEmail[] baseUserEmails) Mutator for baseUserEmails
void	setBaseUserEmails(int index, BaseUserEmail value) Set the value at the index specified.
void	setBaseUserEmails(java.lang.Object[] baseUserEmails) Generic mutator for baseUserEmails
void	setComplete(boolean complete) Mutator for complete
void	setElements(java.lang.Object[] elements) Specified by SandCollectionMessage interface
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
int	sizeofBaseUserEmails() Returns the size of baseUserEmails.

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

baseUserEmails

protected BaseUserEmail[] baseUserEmails

actual element array

queryResult

protected java.lang.String queryResult

support for SandCollectionMessage interface

Constructor Detail

BaseUserEmailCollection

public BaseUserEmailCollection()

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.

getSandTransmitErrorCode

public java.lang.String getSandTransmitErrorCode()

Accessor for sandTransmitErrorCode

Specified by:

getSandTransmitErrorCode in interface SandTransmitMessage

setSandTransmitErrorCode

public void setSandTransmitErrorCode(java.lang.String sandTransmitErrorCode)

Mutator for sandTransmitErrorCode

Specified by:

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

getSandTransmissionLocale

public java.util.Locale getSandTransmissionLocale()

Accessor for sandTransmissionLocale

Specified by:

getSandTransmissionLocale in interface SandTransmitMessage

setSandTransmissionLocale

public void setSandTransmissionLocale(java.util.Locale sandTransmissionLocale)

Mutator for sandTransmissionLocale

Specified by:

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

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.

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

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.

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

getBaseUserEmails

public BaseUserEmail[] getBaseUserEmails()

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

setBaseUserEmails

public void setBaseUserEmails(BaseUserEmail[] baseUserEmails)

Mutator for baseUserEmails

setBaseUserEmails

public void setBaseUserEmails(java.lang.Object[] baseUserEmails)

Generic mutator for baseUserEmails

addBaseUserEmails

public void addBaseUserEmails(BaseUserEmail element)

Appends a value to baseUserEmails

addBaseUserEmails

public void addBaseUserEmails(BaseUserEmail[] elements)

Appends an array of values to baseUserEmails

getBaseUserEmails

public BaseUserEmail getBaseUserEmails(int index)

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

setBaseUserEmails

public void setBaseUserEmails(int index,
                              BaseUserEmail value)

Set the value at the index specified.

insertBaseUserEmails

public void insertBaseUserEmails(int index,
                                 BaseUserEmail 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.

removeBaseUserEmails

public BaseUserEmail removeBaseUserEmails(int index)

Remove the element at the specified index and return it.

removeBaseUserEmailsValue

public boolean removeBaseUserEmailsValue(BaseUserEmail value)

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

clearBaseUserEmails

public void clearBaseUserEmails()

Clears all values from baseUserEmails

baseUserEmailsContains

public boolean baseUserEmailsContains(BaseUserEmail val)

Returns true if baseUserEmails contains the specified value.

baseUserEmailsIndexOf

public int baseUserEmailsIndexOf(BaseUserEmail val)

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

sizeofBaseUserEmails

public int sizeofBaseUserEmails()

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

getBaseUserEmailsFlag

public static boolean getBaseUserEmailsFlag(int fieldflag)

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

getBaseUserEmailsDefaultValue

public static BaseUserEmail[] getBaseUserEmailsDefaultValue()

Default value for baseUserEmails. Returns new BaseUserEmail[0]

getBaseUserEmailsElementInvalidValue

public static BaseUserEmail getBaseUserEmailsElementInvalidValue()

Invalid value for baseUserEmailselement. Returns null

getBaseUserEmailsInvalidValue

public static BaseUserEmail[] getBaseUserEmailsInvalidValue()

Invalid value for baseUserEmails. Returns null

getBaseUserEmailsRange

public java.lang.String getBaseUserEmailsRange()

Return the range specification for this field

getBaseUserEmailsValidityCheck

public java.lang.String getBaseUserEmailsValidityCheck()

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.

getBaseUserEmailsMetatype

public java.lang.String getBaseUserEmailsMetatype()

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

setElements

public void setElements(java.lang.Object[] elements)

Specified by SandCollectionMessage interface

Specified by:

setElements 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

cloneBaseUserEmailCollection

public BaseUserEmailCollection cloneBaseUserEmailCollection()

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 BaseUserEmailQuery instance

Specified by:

getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()

Returns a new BaseUserEmailCollection instance

Specified by:

getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()

Returns a new BaseUserEmailUpdate instance

Specified by:

getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new BaseUserEmail 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.

When comparing arrays, it is possible that the array elements may have been set to null as part of authorization filtering or similar u