SandUI

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.ui.sandmessages
Class SandUI

java.lang.Object
  org.sandev.ui.structs.SandUIStruct
      org.sandev.ui.sandmessages.SandUI

All Implemented Interfaces:: org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.structs.SandTransmitMessage

public class SandUI
extends SandUIStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandTransmitMessage

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

Field Summary
`static int`	`DEFAULTSECURITY_NORMAL` Possible value for defaultSecurity
`static int`	`DEFAULTSECURITY_SECURE` Possible value for defaultSecurity
`static int`	`INITIALDISPLAY_LOGIN` Possible value for initialDisplay
`static int`	`INITIALDISPLAY_WELCOME` Possible value for initialDisplay
`protected int`	`sandTransmissionCount` Counter to aid in tracking receipt of sent messages.
`protected long`	`sandTransmitAuthID` The uniqueID of the authorized user of this message.
`protected java.lang.String`	`sandTransmitErrorMessage` Text details of the transmission error.
`protected int`	`sandTransmitStatus` Status of the message.

Fields inherited from class org.sandev.ui.structs.SandUIStruct

defaultSecurity, defaultTemplate, entryPoints, errorTemplate, initialDisplay, localeCountries, localeLanguages, localeVariants, loginTemplate, name, publicAuthUserID, screens, welcomeTemplate

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

FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

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

Method Summary
`void`	`addEntryPoints(java.lang.String element)` Appends a value to entryPoints
`void`	`addEntryPoints(java.lang.String[] elements)` Appends an array of values to entryPoints
`void`	`addLocaleCountries(java.lang.String element)` Appends a value to localeCountries
`void`	`addLocaleCountries(java.lang.String[] elements)` Appends an array of values to localeCountries
`void`	`addLocaleLanguages(java.lang.String element)` Appends a value to localeLanguages
`void`	`addLocaleLanguages(java.lang.String[] elements)` Appends an array of values to localeLanguages
`void`	`addLocaleVariants(java.lang.String element)` Appends a value to localeVariants
`void`	`addLocaleVariants(java.lang.String[] elements)` Appends an array of values to localeVariants
`void`	`addScreens(Screen element)` Appends a value to screens
`void`	`addScreens(Screen[] elements)` Appends an array of values to screens
`void`	`clearEntryPoints()` Clears all values from entryPoints
`void`	`clearLocaleCountries()` Clears all values from localeCountries
`void`	`clearLocaleLanguages()` Clears all values from localeLanguages
`void`	`clearLocaleVariants()` Clears all values from localeVariants
`void`	`clearScreens()` Clears all values from screens
`org.sandev.basics.structs.SandInstanceMessage`	`cloneMessage()` Calls cloneSandUI
`SandUI`	`cloneSandUI()` Make a deep copy of this SandUI.
`org.sandev.basics.structs.SandInstanceMessage`	`convertToSuperstructClass()` Return a new instance of the message associated with the superstruct of this instance.
`void`	`copyDataFrom(SandUI other)` Deep copy all the data from the specified instance.
`void`	`copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other)` Copy the specified field from the given instance.
`java.lang.String`	`debugDump(java.lang.String prefix)` Dump this instance into a debug printable string.
`void`	`defaultField(java.lang.String fieldname)` Set the specified field to its default value.
`static java.lang.String`	`defaultSecurityActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`defaultSecurityLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static java.lang.String`	`defaultSecurityPrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`defaultSecurityPrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`defaultSecurityValueToLabel(int val)` Given a value, return the declared label for it.
`boolean`	`entryPointsContains(java.lang.String val)` Returns true if entryPoints contains the specified value.
`int`	`entryPointsIndexOf(java.lang.String val)` Return the index of the specified value in entryPoints, or -1 if not found.
`boolean`	`fieldHasFlag(java.lang.String fieldname, int fieldflag)` Return true if the named field declares the indicated flag, false otherwise.
`boolean`	`fieldsValid()` Validate the fields as specified in the SandInstanceMessage interface
`org.sandev.basics.structs.SandAttrVal[]`	`fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)` Validate the fields as specified in the SandInstanceMessage interface
`java.lang.Object`	`generalAccessor(java.lang.String fieldspec)` General field accessor method.
`org.sandev.basics.structs.SandAttrVal`	`generalDereference(java.lang.String fieldspec)` General reference field accessor method.
`void`	`generalModifier(int action, java.lang.String field, int index, java.lang.Object val)` General mutator method.
`java.lang.String[]`	`getAllFields()` Return an array of all fields for this class.
`org.sandev.basics.structs.SandCollectionMessage`	`getCollectionMessage()` Returns null
`int`	`getDefaultSecurity()` Accessor for defaultSecurity
`static java.lang.String[]`	`getDefaultSecurityActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getDefaultSecurityDefaultValue()` Default value for defaultSecurity.
`static java.lang.String`	`getDefaultSecurityEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getDefaultSecurityFieldPrintValue()` Return the print name of the defaultSecurity field.
`static boolean`	`getDefaultSecurityFlag(int fieldflag)` Field flag accessor.
`static int`	`getDefaultSecurityInvalidValue()` Invalid value for defaultSecurity.
`static java.lang.String[]`	`getDefaultSecurityKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getDefaultSecurityMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getDefaultSecurityPrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getDefaultSecurityPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getDefaultSecurityRange()` Return the range specification for this field
`java.lang.String`	`getDefaultSecurityValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getDefaultTemplate()` Accessor for defaultTemplate
`static java.lang.String`	`getDefaultTemplateDefaultValue()` Default value for defaultTemplate.
`java.lang.String`	`getDefaultTemplateFieldPrintValue()` Return the print name of the defaultTemplate field.
`static boolean`	`getDefaultTemplateFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getDefaultTemplateInvalidValue()` Invalid value for defaultTemplate.
`static int`	`getDefaultTemplateLengthMax()` Maximum defaultTemplate length is 80 characters
`static int`	`getDefaultTemplateLengthNorm()` Normal defaultTemplate length is 20 characters
`java.lang.String`	`getDefaultTemplateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getDefaultTemplatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getDefaultTemplateRange()` Return the range specification for this field
`java.lang.String`	`getDefaultTemplateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String[]`	`getDisplayFields()` Return an array of the summary field names for this class.
`java.lang.String[]`	`getDisplayValues()` Return the values for the summary fields.
`java.lang.String[]`	`getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)` Return the values for the summary fields, including dereference expressions.
`java.lang.String[]`	`getEntryPoints()` Accessor for entryPoints
`java.lang.String`	`getEntryPoints(int index)` Returns the element at the specified index.
`static java.lang.String[]`	`getEntryPointsDefaultValue()` Default value for entryPoints.
`static java.lang.String`	`getEntryPointsElementInvalidValue()` Invalid value for entryPointselement.
`static boolean`	`getEntryPointsFlag(int fieldflag)` Field flag accessor.
`static java.lang.String[]`	`getEntryPointsInvalidValue()` Invalid value for entryPoints.
`static int`	`getEntryPointsLengthMax()` Maximum entryPoints length is 70 characters
`static int`	`getEntryPointsLengthNorm()` Normal entryPoints length is 30 characters
`java.lang.String`	`getEntryPointsMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getEntryPointsRange()` Return the range specification for this field
`java.lang.String`	`getEntryPointsValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getErrorTemplate()` Accessor for errorTemplate
`static java.lang.String`	`getErrorTemplateDefaultValue()` Default value for errorTemplate.
`java.lang.String`	`getErrorTemplateFieldPrintValue()` Return the print name of the errorTemplate field.
`static boolean`	`getErrorTemplateFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getErrorTemplateInvalidValue()` Invalid value for errorTemplate.
`static int`	`getErrorTemplateLengthMax()` Maximum errorTemplate length is 80 characters
`static int`	`getErrorTemplateLengthNorm()` Normal errorTemplate length is 20 characters
`java.lang.String`	`getErrorTemplateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getErrorTemplatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getErrorTemplateRange()` Return the range specification for this field
`java.lang.String`	`getErrorTemplateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`int`	`getInitialDisplay()` Accessor for initialDisplay
`static java.lang.String[]`	`getInitialDisplayActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getInitialDisplayDefaultValue()` Default value for initialDisplay.
`static java.lang.String`	`getInitialDisplayEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getInitialDisplayFieldPrintValue()` Return the print name of the initialDisplay field.
`static boolean`	`getInitialDisplayFlag(int fieldflag)` Field flag accessor.
`static int`	`getInitialDisplayInvalidValue()` Invalid value for initialDisplay.
`static java.lang.String[]`	`getInitialDisplayKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getInitialDisplayMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getInitialDisplayPrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getInitialDisplayPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getInitialDisplayRange()` Return the range specification for this field
`java.lang.String`	`getInitialDisplayValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String[]`	`getLocaleCountries()` Accessor for localeCountries
`java.lang.String`	`getLocaleCountries(int index)` Returns the element at the specified index.
`static java.lang.String[]`	`getLocaleCountriesDefaultValue()` Default value for localeCountries.
`static java.lang.String`	`getLocaleCountriesElementInvalidValue()` Invalid value for localeCountrieselement.
`static boolean`	`getLocaleCountriesFlag(int fieldflag)` Field flag accessor.
`static java.lang.String[]`	`getLocaleCountriesInvalidValue()` Invalid value for localeCountries.
`static int`	`getLocaleCountriesLengthMax()` Maximum localeCountries length is 70 characters
`static int`	`getLocaleCountriesLengthNorm()` Normal localeCountries length is 30 characters
`java.lang.String`	`getLocaleCountriesMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLocaleCountriesRange()` Return the range specification for this field
`java.lang.String`	`getLocaleCountriesValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String[]`	`getLocaleLanguages()` Accessor for localeLanguages
`java.lang.String`	`getLocaleLanguages(int index)` Returns the element at the specified index.
`static java.lang.String[]`	`getLocaleLanguagesDefaultValue()` Default value for localeLanguages.
`static java.lang.String`	`getLocaleLanguagesElementInvalidValue()` Invalid value for localeLanguageselement.
`static boolean`	`getLocaleLanguagesFlag(int fieldflag)` Field flag accessor.
`static java.lang.String[]`	`getLocaleLanguagesInvalidValue()` Invalid value for localeLanguages.
`static int`	`getLocaleLanguagesLengthMax()` Maximum localeLanguages length is 70 characters
`static int`	`getLocaleLanguagesLengthNorm()` Normal localeLanguages length is 30 characters
`java.lang.String`	`getLocaleLanguagesMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLocaleLanguagesRange()` Return the range specification for this field
`java.lang.String`	`getLocaleLanguagesValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String[]`	`getLocaleVariants()` Accessor for localeVariants
`java.lang.String`	`getLocaleVariants(int index)` Returns the element at the specified index.
`static java.lang.String[]`	`getLocaleVariantsDefaultValue()` Default value for localeVariants.
`static java.lang.String`	`getLocaleVariantsElementInvalidValue()` Invalid value for localeVariantselement.
`static boolean`	`getLocaleVariantsFlag(int fieldflag)` Field flag accessor.
`static java.lang.String[]`	`getLocaleVariantsInvalidValue()` Invalid value for localeVariants.
`static int`	`getLocaleVariantsLengthMax()` Maximum localeVariants length is 70 characters
`static int`	`getLocaleVariantsLengthNorm()` Normal localeVariants length is 30 characters
`java.lang.String`	`getLocaleVariantsMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLocaleVariantsRange()` Return the range specification for this field
`java.lang.String`	`getLocaleVariantsValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getLoginTemplate()` Accessor for loginTemplate
`static java.lang.String`	`getLoginTemplateDefaultValue()` Default value for loginTemplate.
`java.lang.String`	`getLoginTemplateFieldPrintValue()` Return the print name of the loginTemplate field.
`static boolean`	`getLoginTemplateFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getLoginTemplateInvalidValue()` Invalid value for loginTemplate.
`static int`	`getLoginTemplateLengthMax()` Maximum loginTemplate length is 80 characters
`static int`	`getLoginTemplateLengthNorm()` Normal loginTemplate length is 20 characters
`java.lang.String`	`getLoginTemplateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLoginTemplatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLoginTemplateRange()` Return the range specification for this field
`java.lang.String`	`getLoginTemplateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getName()` Accessor for name
`static java.lang.String`	`getNameDefaultValue()` Default value for name.
`java.lang.String`	`getNameFieldPrintValue()` Return the print name of the name field.
`static boolean`	`getNameFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getNameInvalidValue()` Invalid value for name.
`static int`	`getNameLengthMax()` Maximum name length is 70 characters
`static int`	`getNameLengthNorm()` Normal name length is 30 characters
`java.lang.String`	`getNameMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNamePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNameRange()` Return the range specification for this field
`java.lang.String`	`getNameValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`long`	`getPublicAuthUserID()` Accessor for publicAuthUserID
`static long`	`getPublicAuthUserIDDefaultValue()` Default value for publicAuthUserID.
`java.lang.String`	`getPublicAuthUserIDFieldPrintValue()` Return the print name of the publicAuthUserID field.
`static boolean`	`getPublicAuthUserIDFlag(int fieldflag)` Field flag accessor.
`static long`	`getPublicAuthUserIDInvalidValue()` Invalid value for publicAuthUserID.
`java.lang.String`	`getPublicAuthUserIDMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getPublicAuthUserIDPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getPublicAuthUserIDRange()` Return the range specification for this field
`java.lang.String`	`getPublicAuthUserIDValidityCheck()` 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 null
`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.
`Screen[]`	`getScreens()` Accessor for screens
`Screen`	`getScreens(int index)` Returns the element at the specified index.
`static Screen[]`	`getScreensDefaultValue()` Default value for screens.
`static Screen`	`getScreensElementInvalidValue()` Invalid value for screenselement.
`static boolean`	`getScreensFlag(int fieldflag)` Field flag accessor.
`static Screen[]`	`getScreensInvalidValue()` Invalid value for screens.
`java.lang.String`	`getScreensMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getScreensRange()` Return the range specification for this field
`java.lang.String`	`getScreensValidityCheck()` 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 SandUI instance
`org.sandev.basics.structs.SandUpdateMessage`	`getUpdateMessage()` Returns a new SandUIUpdate instance
`java.lang.String`	`getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)` Returns the print representation of the value of the specified field, or the given default value if innaccessible.
`java.lang.String`	`getWelcomeTemplate()` Accessor for welcomeTemplate
`static java.lang.String`	`getWelcomeTemplateDefaultValue()` Default value for welcomeTemplate.
`java.lang.String`	`getWelcomeTemplateFieldPrintValue()` Return the print name of the welcomeTemplate field.
`static boolean`	`getWelcomeTemplateFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getWelcomeTemplateInvalidValue()` Invalid value for welcomeTemplate.
`static int`	`getWelcomeTemplateLengthMax()` Maximum welcomeTemplate length is 80 characters
`static int`	`getWelcomeTemplateLengthNorm()` Normal welcomeTemplate length is 20 characters
`java.lang.String`	`getWelcomeTemplateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getWelcomeTemplatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getWelcomeTemplateRange()` Return the range specification for this field
`java.lang.String`	`getWelcomeTemplateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`void`	`init()` Initialize all fields to their default values
`static java.lang.String`	`initialDisplayActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`initialDisplayLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static java.lang.String`	`initialDisplayPrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`initialDisplayPrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`initialDisplayValueToLabel(int val)` Given a value, return the declared label for it.
`void`	`insertEntryPoints(int index, java.lang.String value)` Insert the specified element at the specified index.
`void`	`insertLocaleCountries(int index, java.lang.String value)` Insert the specified element at the specified index.
`void`	`insertLocaleLanguages(int index, java.lang.String value)` Insert the specified element at the specified index.
`void`	`insertLocaleVariants(int index, java.lang.String value)` Insert the specified element at the specified index.
`void`	`insertScreens(int index, Screen value)` Insert the specified element at the specified index.
`boolean`	`isDefaultSecurityNormal()` boolean accessor for defaultSecurity value
`boolean`	`isDefaultSecuritySecure()` boolean accessor for defaultSecurity value
`boolean`	`isEquivalent(org.sandev.basics.structs.SandMessage sm)` Declared field equivalence check as specified by the SandMessage interface.
`boolean`	`localeCountriesContains(java.lang.String val)` Returns true if localeCountries contains the specified value.
`int`	`localeCountriesIndexOf(java.lang.String val)` Return the index of the specified value in localeCountries, or -1 if not found.
`boolean`	`localeLanguagesContains(java.lang.String val)` Returns true if localeLanguages contains the specified value.
`int`	`localeLanguagesIndexOf(java.lang.String val)` Return the index of the specified value in localeLanguages, or -1 if not found.
`boolean`	`localeVariantsContains(java.lang.String val)` Returns true if localeVariants contains the specified value.
`int`	`localeVariantsIndexOf(java.lang.String val)` Return the index of the specified value in localeVariants, or -1 if not found.
`java.lang.String[]`	`referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au)` Validate the references as specified in the Resolvable interface.
`java.lang.String`	`removeEntryPoints(int index)` Remove the element at the specified index and return it.
`boolean`	`removeEntryPointsValue(java.lang.String value)` Removes the given element from entryPoints.
`java.lang.String`	`removeLocaleCountries(int index)` Remove the element at the specified index and return it.
`boolean`	`removeLocaleCountriesValue(java.lang.String value)` Removes the given element from localeCountries.
`java.lang.String`	`removeLocaleLanguages(int index)` Remove the element at the specified index and return it.
`boolean`	`removeLocaleLanguagesValue(java.lang.String value)` Removes the given element from localeLanguages.
`java.lang.String`	`removeLocaleVariants(int index)` Remove the element at the specified index and return it.
`boolean`	`removeLocaleVariantsValue(java.lang.String value)` Removes the given element from localeVariants.
`Screen`	`removeScreens(int index)` Remove the element at the specified index and return it.
`boolean`	`removeScreensValue(Screen value)` Removes the given element from screens.
`Screen[]`	`resolveEntryPointsReferences(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au)` Converts this array of references into an array of instances, by looking them up.
`Screen[]`	`resolveEntryPointsReferencesNonCrit(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au)` Calls standard method, eating any SandException and returning an empty array.
`boolean`	`screensContains(Screen val)` Returns true if screens contains the specified value.
`int`	`screensIndexOf(Screen val)` Return the index of the specified value in screens, or -1 if not found.
`void`	`setDefaultSecurity(int defaultSecurity)` Mutator for defaultSecurity
`void`	`setDefaultTemplate(java.lang.Object defaultTemplate)` Generic mutator for defaultTemplate
`void`	`setDefaultTemplate(java.lang.String defaultTemplate)` Mutator for defaultTemplate
`void`	`setEntryPoints(int index, java.lang.String value)` Set the value at the index specified.
`void`	`setEntryPoints(java.lang.String[] entryPoints)` Mutator for entryPoints
`void`	`setErrorTemplate(java.lang.Object errorTemplate)` Generic mutator for errorTemplate
`void`	`setErrorTemplate(java.lang.String errorTemplate)` Mutator for errorTemplate
`void`	`setInitialDisplay(int initialDisplay)` Mutator for initialDisplay
`void`	`setLocaleCountries(int index, java.lang.String value)` Set the value at the index specified.
`void`	`setLocaleCountries(java.lang.String[] localeCountries)` Mutator for localeCountries
`void`	`setLocaleLanguages(int index, java.lang.String value)` Set the value at the index specified.
`void`	`setLocaleLanguages(java.lang.String[] localeLanguages)` Mutator for localeLanguages
`void`	`setLocaleVariants(int index, java.lang.String value)` Set the value at the index specified.
`void`	`setLocaleVariants(java.lang.String[] localeVariants)` Mutator for localeVariants
`void`	`setLoginTemplate(java.lang.Object loginTemplate)` Generic mutator for loginTemplate
`void`	`setLoginTemplate(java.lang.String loginTemplate)` Mutator for loginTemplate
`void`	`setName(java.lang.Object name)` Generic mutator for name
`void`	`setName(java.lang.String name)` Mutator for name
`void`	`setPublicAuthUserID(long publicAuthUserID)` Mutator for publicAuthUserID
`void`	`setSandTransmissionCount(int sandTransmissionCount)` Mutator for sandTransmissionCount
`void`	`setSandTransmitAuthID(long sandTransmitAuthID)` Mutator for sandTransmitAuthID
`void`	`setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)` Generic mutator for sandTransmitErrorMessage
`void`	`setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)` Mutator for sandTransmitErrorMessage
`void`	`setSandTransmitStatus(int sandTransmitStatus)` Mutator for sandTransmitStatus
`void`	`setScreens(int index, Screen value)` Set the value at the index specified.
`void`	`setScreens(java.lang.Object[] screens)` Generic mutator for screens
`void`	`setScreens(Screen[] screens)` Mutator for screens
`void`	`setWelcomeTemplate(java.lang.Object welcomeTemplate)` Generic mutator for welcomeTemplate
`void`	`setWelcomeTemplate(java.lang.String welcomeTemplate)` Mutator for welcomeTemplate
`int`	`sizeofEntryPoints()` Returns the size of entryPoints.
`int`	`sizeofLocaleCountries()` Returns the size of localeCountries.
`int`	`sizeofLocaleLanguages()` Returns the size of localeLanguages.
`int`	`sizeofLocaleVariants()` Returns the size of localeVariants.
`int`	`sizeofScreens()` Returns the size of screens.
`java.lang.String`	`toString()` Return a string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTSECURITY_NORMAL

public static final int DEFAULTSECURITY_NORMAL

Possible value for defaultSecurity

See Also:: Constant Field Values

DEFAULTSECURITY_SECURE

public static final int DEFAULTSECURITY_SECURE

Possible value for defaultSecurity

See Also:: Constant Field Values

INITIALDISPLAY_WELCOME

public static final int INITIALDISPLAY_WELCOME

Possible value for initialDisplay

See Also:: Constant Field Values

INITIALDISPLAY_LOGIN

public static final int INITIALDISPLAY_LOGIN

Possible value for initialDisplay

See Also:: Constant Field Values

sandTransmitStatus

protected int sandTransmitStatus

Status of the message. Possible values are defined in SandTransmitMessage.

sandTransmitErrorMessage

protected java.lang.String sandTransmitErrorMessage

Text details of the transmission error.

sandTransmissionCount

protected int sandTransmissionCount

Counter to aid in tracking receipt of sent messages.

sandTransmitAuthID

protected long sandTransmitAuthID

The uniqueID of the authorized user of this message.

Constructor Detail

SandUI

public SandUI()

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.

Specified by:: fieldHasFlag in interface org.sandev.basics.structs.SandInstanceMessage

getName

public java.lang.String getName()

Accessor for name

setName

public void setName(java.lang.String name)

Mutator for name

setName

public void setName(java.lang.Object name)

Generic mutator for name

getNameFlag

public static boolean getNameFlag(int fieldflag)

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

getNameLengthNorm

public static int getNameLengthNorm()

Normal name length is 30 characters

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 70 characters

getNameDefaultValue

public static java.lang.String getNameDefaultValue()

Default value for name. Returns ""

getNameInvalidValue

public static java.lang.String getNameInvalidValue()

Invalid value for name. Returns ""

getNamePrintValue

public java.lang.String getNamePrintValue()

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.

getNameFieldPrintValue

public java.lang.String getNameFieldPrintValue()

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

getNameRange

public java.lang.String getNameRange()

Return the range specification for this field

getNameValidityCheck

public java.lang.String getNameValidityCheck()

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.

getNameMetatype

public java.lang.String getNameMetatype()

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

getDefaultTemplate

public java.lang.String getDefaultTemplate()

Accessor for defaultTemplate

setDefaultTemplate

public void setDefaultTemplate(java.lang.String defaultTemplate)

Mutator for defaultTemplate

setDefaultTemplate

public void setDefaultTemplate(java.lang.Object defaultTemplate)

Generic mutator for defaultTemplate

getDefaultTemplateFlag

public static boolean getDefaultTemplateFlag(int fieldflag)

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

getDefaultTemplateLengthNorm

public static int getDefaultTemplateLengthNorm()

Normal defaultTemplate length is 20 characters

getDefaultTemplateLengthMax

public static int getDefaultTemplateLengthMax()

Maximum defaultTemplate length is 80 characters

getDefaultTemplateDefaultValue

public static java.lang.String getDefaultTemplateDefaultValue()

Default value for defaultTemplate. Returns ""

getDefaultTemplateInvalidValue

public static java.lang.String getDefaultTemplateInvalidValue()

Invalid value for defaultTemplate. Returns "INVALID_TEMPLATE_NAME"

getDefaultTemplatePrintValue

public java.lang.String getDefaultTemplatePrintValue()

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

getDefaultTemplateFieldPrintValue

public java.lang.String getDefaultTemplateFieldPrintValue()

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

getDefaultTemplateRange

public java.lang.String getDefaultTemplateRange()

Return the range specification for this field

getDefaultTemplateValidityCheck

public java.lang.String getDefaultTemplateValidityCheck()

getDefaultTemplateMetatype

public java.lang.String getDefaultTemplateMetatype()

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

getDefaultSecurity

public int getDefaultSecurity()

Accessor for defaultSecurity

setDefaultSecurity

public void setDefaultSecurity(int defaultSecurity)

Mutator for defaultSecurity

defaultSecurityValueToLabel

public java.lang.String defaultSecurityValueToLabel(int val)

Given a value, return the declared label for it. This is a conversion method suitable for things like XML serialization where the value must be unique, descriptive, and readable, but is not subject to the same degree of transformation as a UI.

defaultSecurityLabelToValue

public int defaultSecurityLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

getDefaultSecurityPrintVals

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

Return an array of the possible values for this field in display format. These values can be used by a UI directly, or as keys for looking up localized text. These values are not guaranteed to be globally unique, another field with the same possible value may share the same string instance.

getDefaultSecurityKeyVals

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

Return an array of unique keys for the values of this field. These keys are globally unique and can be used for looking up localized text without any chance of the same key being used by any other field value in the application.

getDefaultSecurityActualVals

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

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

defaultSecurityPrint2Key

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

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

defaultSecurityPrint2Actual

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

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

defaultSecurityActual2Print

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

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

getDefaultSecurityEnumSummary

public static java.lang.String getDefaultSecurityEnumSummary()

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

isDefaultSecurityNormal

public boolean isDefaultSecurityNormal()

boolean accessor for defaultSecurity value

isDefaultSecuritySecure

public boolean isDefaultSecuritySecure()

boolean accessor for defaultSecurity value

getDefaultSecurityFlag

public static boolean getDefaultSecurityFlag(int fieldflag)

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

getDefaultSecurityDefaultValue

public static int getDefaultSecurityDefaultValue()

Default value for defaultSecurity. Returns DEFAULTSECURITY_NORMAL

getDefaultSecurityInvalidValue

public static int getDefaultSecurityInvalidValue()

Invalid value for defaultSecurity. Returns -1

getDefaultSecurityPrintValue

public java.lang.String getDefaultSecurityPrintValue()

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

getDefaultSecurityFieldPrintValue

public java.lang.String getDefaultSecurityFieldPrintValue()

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

getDefaultSecurityRange

public java.lang.String getDefaultSecurityRange()

Return the range specification for this field

getDefaultSecurityValidityCheck

public java.lang.String getDefaultSecurityValidityCheck()

getDefaultSecurityMetatype

public java.lang.String getDefaultSecurityMetatype()

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

getPublicAuthUserID

public long getPublicAuthUserID()

Accessor for publicAuthUserID

setPublicAuthUserID

public void setPublicAuthUserID(long publicAuthUserID)

Mutator for publicAuthUserID

getPublicAuthUserIDFlag

public static boolean getPublicAuthUserIDFlag(int fieldflag)

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

getPublicAuthUserIDDefaultValue

public static long getPublicAuthUserIDDefaultValue()

Default value for publicAuthUserID. Returns 0

getPublicAuthUserIDInvalidValue

public static long getPublicAuthUserIDInvalidValue()

Invalid value for publicAuthUserID. Returns Long.MIN_VALUE

getPublicAuthUserIDPrintValue

public java.lang.String getPublicAuthUserIDPrintValue()

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

getPublicAuthUserIDFieldPrintValue

public java.lang.String getPublicAuthUserIDFieldPrintValue()

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

getPublicAuthUserIDRange

public java.lang.String getPublicAuthUserIDRange()

Return the range specification for this field

getPublicAuthUserIDValidityCheck

public java.lang.String getPublicAuthUserIDValidityCheck()

getPublicAuthUserIDMetatype

public java.lang.String getPublicAuthUserIDMetatype()

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

getWelcomeTemplate

public java.lang.String getWelcomeTemplate()

Accessor for welcomeTemplate

setWelcomeTemplate

public void setWelcomeTemplate(java.lang.String welcomeTemplate)

Mutator for welcomeTemplate

setWelcomeTemplate

public void setWelcomeTemplate(java.lang.Object welcomeTemplate)

Generic mutator for welcomeTemplate

getWelcomeTemplateFlag

public static boolean getWelcomeTemplateFlag(int fieldflag)

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

getWelcomeTemplateLengthNorm

public static int getWelcomeTemplateLengthNorm()

Normal welcomeTemplate length is 20 characters

getWelcomeTemplateLengthMax

public static int getWelcomeTemplateLengthMax()

Maximum welcomeTemplate length is 80 characters

getWelcomeTemplateDefaultValue

public static java.lang.String getWelcomeTemplateDefaultValue()

Default value for welcomeTemplate. Returns ""

getWelcomeTemplateInvalidValue

public static java.lang.String getWelcomeTemplateInvalidValue()

Invalid value for welcomeTemplate. Returns "INVALID_TEMPLATE_NAME"

getWelcomeTemplatePrintValue

public java.lang.String getWelcomeTemplatePrintValue()

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

getWelcomeTemplateFieldPrintValue

public java.lang.String getWelcomeTemplateFieldPrintValue()

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

getWelcomeTemplateRange

public java.lang.String getWelcomeTemplateRange()

Return the range specification for this field

getWelcomeTemplateValidityCheck

public java.lang.String getWelcomeTemplateValidityCheck()

getWelcomeTemplateMetatype

public java.lang.String getWelcomeTemplateMetatype()

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

getInitialDisplay

public int getInitialDisplay()

Accessor for initialDisplay

setInitialDisplay

public void setInitialDisplay(int initialDisplay)

Mutator for initialDisplay

initialDisplayValueToLabel

public java.lang.String initialDisplayValueToLabel(int val)

initialDisplayLabelToValue

public int initialDisplayLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

getInitialDisplayPrintVals

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

getInitialDisplayKeyVals

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

getInitialDisplayActualVals

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

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

initialDisplayPrint2Key

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

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

initialDisplayPrint2Actual

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

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

initialDisplayActual2Print

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

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

getInitialDisplayEnumSummary

public static java.lang.String getInitialDisplayEnumSummary()

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

getInitialDisplayFlag

public static boolean getInitialDisplayFlag(int fieldflag)

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

getInitialDisplayDefaultValue

public static int getInitialDisplayDefaultValue()

Default value for initialDisplay. Returns INITIALDISPLAY_WELCOME

getInitialDisplayInvalidValue

public static int getInitialDisplayInvalidValue()

Invalid value for initialDisplay. Returns -1

getInitialDisplayPrintValue

public java.lang.String getInitialDisplayPrintValue()

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

getInitialDisplayFieldPrintValue

public java.lang.String getInitialDisplayFieldPrintValue()

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

getInitialDisplayRange

public java.lang.String getInitialDisplayRange()

Return the range specification for this field

getInitialDisplayValidityCheck

public java.lang.String getInitialDisplayValidityCheck()

getInitialDisplayMetatype

public java.lang.String getInitialDisplayMetatype()

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

getLoginTemplate

public java.lang.String getLoginTemplate()

Accessor for loginTemplate

setLoginTemplate

public void setLoginTemplate(java.lang.String loginTemplate)

Mutator for loginTemplate

setLoginTemplate

public void setLoginTemplate(java.lang.Object loginTemplate)

Generic mutator for loginTemplate

getLoginTemplateFlag

public static boolean getLoginTemplateFlag(int fieldflag)

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

getLoginTemplateLengthNorm

public static int getLoginTemplateLengthNorm()

Normal loginTemplate length is 20 characters

getLoginTemplateLengthMax

public static int getLoginTemplateLengthMax()

Maximum loginTemplate length is 80 characters

getLoginTemplateDefaultValue

public static java.lang.String getLoginTemplateDefaultValue()

Default value for loginTemplate. Returns ""

getLoginTemplateInvalidValue

public static java.lang.String getLoginTemplateInvalidValue()

Invalid value for loginTemplate. Returns "INVALID_TEMPLATE_NAME"

getLoginTemplatePrintValue

public java.lang.String getLoginTemplatePrintValue()

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

getLoginTemplateFieldPrintValue

public java.lang.String getLoginTemplateFieldPrintValue()

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

getLoginTemplateRange

public java.lang.String getLoginTemplateRange()

Return the range specification for this field

getLoginTemplateValidityCheck

public java.lang.String getLoginTemplateValidityCheck()

getLoginTemplateMetatype

public java.lang.String getLoginTemplateMetatype()

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

getErrorTemplate

public java.lang.String getErrorTemplate()

Accessor for errorTemplate

setErrorTemplate

public void setErrorTemplate(java.lang.String errorTemplate)

Mutator for errorTemplate

setErrorTemplate

public void setErrorTemplate(java.lang.Object errorTemplate)

Generic mutator for errorTemplate

getErrorTemplateFlag

public static boolean getErrorTemplateFlag(int fieldflag)

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

getErrorTemplateLengthNorm

public static int getErrorTemplateLengthNorm()

Normal errorTemplate length is 20 characters

getErrorTemplateLengthMax

public static int getErrorTemplateLengthMax()

Maximum errorTemplate length is 80 characters

getErrorTemplateDefaultValue

public static java.lang.String getErrorTemplateDefaultValue()

Default value for errorTemplate. Returns ""

getErrorTemplateInvalidValue

public static java.lang.String getErrorTemplateInvalidValue()

Invalid value for errorTemplate. Returns "INVALID_TEMPLATE_NAME"

getErrorTemplatePrintValue

public java.lang.String getErrorTemplatePrintValue()

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

getErrorTemplateFieldPrintValue

public java.lang.String getErrorTemplateFieldPrintValue()

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

getErrorTemplateRange

public java.lang.String getErrorTemplateRange()

Return the range specification for this field

getErrorTemplateValidityCheck

public java.lang.String getErrorTemplateValidityCheck()

getErrorTemplateMetatype

public java.lang.String getErrorTemplateMetatype()

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

getEntryPoints

public java.lang.String[] getEntryPoints()

Accessor for entryPoints

setEntryPoints

public void setEntryPoints(java.lang.String[] entryPoints)

Mutator for entryPoints

addEntryPoints

public void addEntryPoints(java.lang.String element)

Appends a value to entryPoints

addEntryPoints

public void addEntryPoints(java.lang.String[] elements)

Appends an array of values to entryPoints

getEntryPoints

public java.lang.String getEntryPoints(int index)

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

setEntryPoints

public void setEntryPoints(int index,
                           java.lang.String value)

Set the value at the index specified.

insertEntryPoints

public void insertEntryPoints(int index,
                              java.lang.String 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.

removeEntryPoints

public java.lang.String removeEntryPoints(int index)

Remove the element at the specified index and return it.

removeEntryPointsValue

public boolean removeEntryPointsValue(java.lang.String value)

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

clearEntryPoints

public void clearEntryPoints()

Clears all values from entryPoints

entryPointsContains

public boolean entryPointsContains(java.lang.String val)

Returns true if entryPoints contains the specified value.

entryPointsIndexOf

public int entryPointsIndexOf(java.lang.String val)

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

sizeofEntryPoints

public int sizeofEntryPoints()

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

getEntryPointsFlag

public static boolean getEntryPointsFlag(int fieldflag)

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

getEntryPointsLengthNorm

public static int getEntryPointsLengthNorm()

Normal entryPoints length is 30 characters

getEntryPointsLengthMax

public static int getEntryPointsLengthMax()

Maximum entryPoints length is 70 characters

getEntryPointsDefaultValue

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

Default value for entryPoints. Returns new String[0]

getEntryPointsElementInvalidValue

public static java.lang.String getEntryPointsElementInvalidValue()

Invalid value for entryPointselement. Returns null

getEntryPointsInvalidValue

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

Invalid value for entryPoints. Returns null

getEntryPointsRange

public java.lang.String getEntryPointsRange()

Return the range specification for this field

resolveEntryPointsReferencesNonCrit

public Screen[] resolveEntryPointsReferencesNonCrit(org.sandev.basics.util.NameLookup lookup,
                                                    org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning an empty array. This is to support the UI, which is basically calling to get detail for a richer display. If the detail is not available, it's not critical (hence the name).

resolveEntryPointsReferences

public Screen[] resolveEntryPointsReferences(org.sandev.basics.util.NameLookup lookup,
                                             org.sandev.basics.util.AuthUser au)
                                      throws org.sandev.basics.structs.SandException

Converts this array of references into an array of instances, by looking them up.

Throws:: org.sandev.basics.structs.SandException

getEntryPointsValidityCheck

public java.lang.String getEntryPointsValidityCheck()

getEntryPointsMetatype

public java.lang.String getEntryPointsMetatype()

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

getScreens

public Screen[] getScreens()

Accessor for screens

setScreens

public void setScreens(Screen[] screens)

Mutator for screens

setScreens

public void setScreens(java.lang.Object[] screens)

Generic mutator for screens

addScreens

public void addScreens(Screen element)

Appends a value to screens

addScreens

public void addScreens(Screen[] elements)

Appends an array of values to screens

getScreens

public Screen getScreens(int index)

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

setScreens

public void setScreens(int index,
                       Screen value)

Set the value at the index specified.

insertScreens

public void insertScreens(int index,
                          Screen 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.

removeScreens

public Screen removeScreens(int index)

Remove the element at the specified index and return it.

removeScreensValue

public boolean removeScreensValue(Screen value)

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

clearScreens

public void clearScreens()

Clears all values from screens

screensContains

public boolean screensContains(Screen val)

Returns true if screens contains the specified value.

screensIndexOf

public int screensIndexOf(Screen val)

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

sizeofScreens

public int sizeofScreens()

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

getScreensFlag

public static boolean getScreensFlag(int fieldflag)

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

getScreensDefaultValue

public static Screen[] getScreensDefaultValue()

Default value for screens. Returns new Screen[0]

getScreensElementInvalidValue

public static Screen getScreensElementInvalidValue()

Invalid value for screenselement. Returns null

getScreensInvalidValue

public static Screen[] getScreensInvalidValue()

Invalid value for screens. Returns null

getScreensRange

public java.lang.String getScreensRange()

Return the range specification for this field

getScreensValidityCheck

public java.lang.String getScreensValidityCheck()

getScreensMetatype

public java.lang.String getScreensMetatype()

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

getLocaleLanguages

public java.lang.String[] getLocaleLanguages()

Accessor for localeLanguages

setLocaleLanguages

public void setLocaleLanguages(java.lang.String[] localeLanguages)

Mutator for localeLanguages

addLocaleLanguages

public void addLocaleLanguages(java.lang.String element)

Appends a value to localeLanguages

addLocaleLanguages

public void addLocaleLanguages(java.lang.String[] elements)

Appends an array of values to localeLanguages

getLocaleLanguages

public java.lang.String getLocaleLanguages(int index)

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

setLocaleLanguages

public void setLocaleLanguages(int index,
                               java.lang.String value)

Set the value at the index specified.

insertLocaleLanguages

public void insertLocaleLanguages(int index,
                                  java.lang.String 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.

removeLocaleLanguages

public java.lang.String removeLocaleLanguages(int index)

Remove the element at the specified index and return it.

removeLocaleLanguagesValue

public boolean removeLocaleLanguagesValue(java.lang.String value)

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

clearLocaleLanguages

public void clearLocaleLanguages()

Clears all values from localeLanguages

localeLanguagesContains

public boolean localeLanguagesContains(java.lang.String val)

Returns true if localeLanguages contains the specified value.

localeLanguagesIndexOf

public int localeLanguagesIndexOf(java.lang.String val)

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

sizeofLocaleLanguages

public int sizeofLocaleLanguages()

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

getLocaleLanguagesFlag

public static boolean getLocaleLanguagesFlag(int fieldflag)

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

getLocaleLanguagesLengthNorm

public static int getLocaleLanguagesLengthNorm()

Normal localeLanguages length is 30 characters

getLocaleLanguagesLengthMax

public static int getLocaleLanguagesLengthMax()

Maximum localeLanguages length is 70 characters

getLocaleLanguagesDefaultValue

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

Default value for localeLanguages. Returns new String[0]

getLocaleLanguagesElementInvalidValue

public static java.lang.String getLocaleLanguagesElementInvalidValue()

Invalid value for localeLanguageselement. Returns null

getLocaleLanguagesInvalidValue

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

Invalid value for localeLanguages. Returns null

getLocaleLanguagesRange

public java.lang.String getLocaleLanguagesRange()

Return the range specification for this field

getLocaleLanguagesValidityCheck

public java.lang.String getLocaleLanguagesValidityCheck()

getLocaleLanguagesMetatype

public java.lang.String getLocaleLanguagesMetatype()

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

getLocaleCountries

public java.lang.String[] getLocaleCountries()

Accessor for localeCountries

setLocaleCountries

public void setLocaleCountries(java.lang.String[] localeCountries)

Mutator for localeCountries

addLocaleCountries

public void addLocaleCountries(java.lang.String element)

Appends a value to localeCountries

addLocaleCountries

public void addLocaleCountries(java.lang.String[] elements)

Appends an array of values to localeCountries

getLocaleCountries

public java.lang.String getLocaleCountries(int index)

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

setLocaleCountries

public void setLocaleCountries(int index,
                               java.lang.String value)

Set the value at the index specified.

insertLocaleCountries

public void insertLocaleCountries(int index,
                                  java.lang.String 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.

removeLocaleCountries

public java.lang.String removeLocaleCountries(int index)

Remove the element at the specified index and return it.

removeLocaleCountriesValue

public boolean removeLocaleCountriesValue(java.lang.String value)

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

clearLocaleCountries

public void clearLocaleCountries()

Clears all values from localeCountries

localeCountriesContains

public boolean localeCountriesContains(java.lang.String val)

Returns true if localeCountries contains the specified value.

localeCountriesIndexOf

public int localeCountriesIndexOf(java.lang.String val)

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

sizeofLocaleCountries

public int sizeofLocaleCountries()

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

getLocaleCountriesFlag

public static boolean getLocaleCountriesFlag(int fieldflag)

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

getLocaleCountriesLengthNorm

public static int getLocaleCountriesLengthNorm()

Normal localeCountries length is 30 characters

getLocaleCountriesLengthMax

public static int getLocaleCountriesLengthMax()

Maximum localeCountries length is 70 characters

getLocaleCountriesDefaultValue

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

Default value for localeCountries. Returns new String[0]

getLocaleCountriesElementInvalidValue

public static java.lang.String getLocaleCountriesElementInvalidValue()

Invalid value for localeCountrieselement. Returns null

getLocaleCountriesInvalidValue

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

Invalid value for localeCountries. Returns null

getLocaleCountriesRange

public java.lang.String getLocaleCountriesRange()

Return the range specification for this field

getLocaleCountriesValidityCheck

public java.lang.String getLocaleCountriesValidityCheck()

getLocaleCountriesMetatype

public java.lang.String getLocaleCountriesMetatype()

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

getLocaleVariants

public java.lang.String[] getLocaleVariants()

Accessor for localeVariants

setLocaleVariants

public void setLocaleVariants(java.lang.String[] localeVariants)

Mutator for localeVariants

addLocaleVariants

public void addLocaleVariants(java.lang.String element)

Appends a value to localeVariants

addLocaleVariants

public void addLocaleVariants(java.lang.String[] elements)

Appends an array of values to localeVariants

getLocaleVariants

public java.lang.String getLocaleVariants(int index)

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

setLocaleVariants

public void setLocaleVariants(int index,
                              java.lang.String value)

Set the value at the index specified.

insertLocaleVariants

public void insertLocaleVariants(int index,
                                 java.lang.String 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.

removeLocaleVariants

public java.lang.String removeLocaleVariants(int index)

Remove the element at the specified index and return it.

removeLocaleVariantsValue

public boolean removeLocaleVariantsValue(java.lang.String value)

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

clearLocaleVariants

public void clearLocaleVariants()

Clears all values from localeVariants

localeVariantsContains

public boolean localeVariantsContains(java.lang.String val)

Returns true if localeVariants contains the specified value.

localeVariantsIndexOf

public int localeVariantsIndexOf(java.lang.String val)

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

sizeofLocaleVariants

public int sizeofLocaleVariants()

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

getLocaleVariantsFlag

public static boolean getLocaleVariantsFlag(int fieldflag)

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

getLocaleVariantsLengthNorm

public static int getLocaleVariantsLengthNorm()

Normal localeVariants length is 30 characters

getLocaleVariantsLengthMax

public static int getLocaleVariantsLengthMax()

Maximum localeVariants length is 70 characters

getLocaleVariantsDefaultValue

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

Default value for localeVariants. Returns new String[0]

getLocaleVariantsElementInvalidValue

public static java.lang.String getLocaleVariantsElementInvalidValue()

Invalid value for localeVariantselement. Returns null

getLocaleVariantsInvalidValue

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

Invalid value for localeVariants. Returns null

getLocaleVariantsRange

public java.lang.String getLocaleVariantsRange()

Return the range specification for this field

getLocaleVariantsValidityCheck

public java.lang.String getLocaleVariantsValidityCheck()

getLocaleVariantsMetatype

public java.lang.String getLocaleVariantsMetatype()

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.

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.

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.

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

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

getSandTransmitAuthIDMetatype

public java.lang.String getSandTransmitAuthIDMetatype()

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

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:: getShortName in interface org.sandev.basics.structs.SandMessage

getQueryMessage

public org.sandev.basics.structs.SandQueryMessage getQueryMessage()

Returns null

Specified by:: getQueryMessage in interface org.sandev.basics.structs.SandMessage

getCollectionMessage

public org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()

Returns null

Specified by:: getCollectionMessage in interface org.sandev.basics.structs.SandMessage

getUpdateMessage

public org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()

Returns a new SandUIUpdate instance

Specified by:: getUpdateMessage in interface org.sandev.basics.structs.SandMessage

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()

Returns a new SandUI instance

Specified by:: getStructMessage in interface org.sandev.basics.structs.SandMessage

isEquivalent

public boolean isEquivalent(org.sandev.basics.structs.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 org.sandev.basics.structs.SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws org.sandev.basics.structs.SandException

General mutator method. Specified by SandInstanceMessage interface.

Specified by:: generalModifier in interface org.sandev.basics.structs.SandInstanceMessage

Throws:: org.sandev.basics.structs.SandException

generalDereference

public org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:: generalDereference in interface org.sandev.basics.structs.SandInstanceMessage

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:: generalAccessor in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

Return an array of the summary field names for this class.

Specified by:: getDisplayFields in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues()

Return the values for the summary fields. The standard String representation of each value is returned. For Dates, the default DateFormat output is used. For enums, the print value is used. These can be further transformed as needed.

Specified by:: getDisplayValues in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup,
                                           org.sandev.basics.util.AuthUser user,
                                           java.lang.String defaultVal)

Return the values for the summary fields, including dereference expressions.

Specified by:: getDisplayValues in interface org.sandev.basics.util.Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             org.sandev.basics.util.IDLookup lookup,
                                             org.sandev.basics.util.AuthUser user,
                                             java.lang.String defaultVal)

Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

toString

public java.lang.String toString()

Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:: getAllFields in interface org.sandev.basics.structs.SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:: defaultField in interface org.sandev.basics.structs.SandInstanceMessage

cloneMessage

public org.sandev.basics.structs.SandInstanceMessage cloneMessage()

Calls cloneSandUI

Specified by:: cloneMessage in interface org.sandev.basics.structs.SandInstanceMessage

cloneSandUI

public SandUI cloneSandUI()

Make a deep copy of this SandUI. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(SandUI other)

Deep copy all the data from the specified instance. If the other instance is null then this method does nothing.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           org.sandev.basics.structs.SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:: copyFieldValue in interface org.sandev.basics.structs.SandInstanceMessage

fieldValidate

public org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:: fieldValidate in interface org.sandev.basics.structs.SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:: fieldsValid in interface org.sandev.basics.structs.SandInstanceMessage

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            org.sandev.basics.util.IDLookup idlookup,
                                            org.sandev.basics.util.NameLookup namelookup,
                                            org.sandev.basics.util.AuthUser au)
                                     throws org.sandev.basics.structs.SandException

Validate the references as specified in the Resolvable interface.

Specified by:: referenceValidate in interface org.sandev.basics.util.Resolvable

Throws:: org.sandev.basics.structs.SandException

convertToSuperstructClass

public org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()

Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:: convertToSuperstructClass in interface org.sandev.basics.structs.SandInstanceMessage

debugDump

public java.lang.String debugDump(java.lang.String prefix)

Dump this instance into a debug printable string.

Specified by:: debugDump in interface org.sandev.basics.structs.SandInstanceMessage

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.ui.sandmessages Class SandUI

DEFAULTSECURITY_NORMAL

DEFAULTSECURITY_SECURE

INITIALDISPLAY_WELCOME

INITIALDISPLAY_LOGIN

sandTransmitStatus

sandTransmitErrorMessage

sandTransmissionCount

sandTransmitAuthID

SandUI

fieldHasFlag

getName

setName

setName

getNameFlag

getNameLengthNorm

getNameLengthMax

getNameDefaultValue

getNameInvalidValue

getNamePrintValue

getNameFieldPrintValue

getNameRange

getNameValidityCheck

getNameMetatype

getDefaultTemplate

setDefaultTemplate

setDefaultTemplate

getDefaultTemplateFlag

getDefaultTemplateLengthNorm

getDefaultTemplateLengthMax

getDefaultTemplateDefaultValue

getDefaultTemplateInvalidValue

getDefaultTemplatePrintValue

getDefaultTemplateFieldPrintValue

getDefaultTemplateRange

getDefaultTemplateValidityCheck

getDefaultTemplateMetatype

getDefaultSecurity

setDefaultSecurity

defaultSecurityValueToLabel

defaultSecurityLabelToValue

getDefaultSecurityPrintVals

getDefaultSecurityKeyVals

getDefaultSecurityActualVals

defaultSecurityPrint2Key

defaultSecurityPrint2Actual

defaultSecurityActual2Print

getDefaultSecurityEnumSummary

isDefaultSecurityNormal

isDefaultSecuritySecure

getDefaultSecurityFlag

getDefaultSecurityDefaultValue

getDefaultSecurityInvalidValue

getDefaultSecurityPrintValue

getDefaultSecurityFieldPrintValue

getDefaultSecurityRange

getDefaultSecurityValidityCheck

getDefaultSecurityMetatype

getPublicAuthUserID

setPublicAuthUserID

getPublicAuthUserIDFlag

getPublicAuthUserIDDefaultValue

getPublicAuthUserIDInvalidValue

getPublicAuthUserIDPrintValue

getPublicAuthUserIDFieldPrintValue

getPublicAuthUserIDRange

getPublicAuthUserIDValidityCheck

getPublicAuthUserIDMetatype

getWelcomeTemplate

setWelcomeTemplate

setWelcomeTemplate

getWelcomeTemplateFlag

getWelcomeTemplateLengthNorm

getWelcomeTemplateLengthMax

getWelcomeTemplateDefaultValue

getWelcomeTemplateInvalidValue

getWelcomeTemplatePrintValue

getWelcomeTemplateFieldPrintValue

getWelcomeTemplateRange

getWelcomeTemplateValidityCheck

org.sandev.ui.sandmessages
Class SandUI