|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.sandev.ui.structs.SandUIStruct
org.sandev.ui.sandmessages.SandUI
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 |
public static final int DEFAULTSECURITY_NORMAL
public static final int DEFAULTSECURITY_SECURE
public static final int INITIALDISPLAY_WELCOME
public static final int INITIALDISPLAY_LOGIN
protected int sandTransmitStatus
SandTransmitMessage.
protected java.lang.String sandTransmitErrorMessage
protected int sandTransmissionCount
protected long sandTransmitAuthID
| Constructor Detail |
public SandUI()
| Method Detail |
public boolean fieldHasFlag(java.lang.String fieldname,
int fieldflag)
fieldHasFlag in interface org.sandev.basics.structs.SandInstanceMessagepublic java.lang.String getName()
public void setName(java.lang.String name)
public void setName(java.lang.Object name)
public static boolean getNameFlag(int fieldflag)
public static int getNameLengthNorm()
public static int getNameLengthMax()
public static java.lang.String getNameDefaultValue()
public static java.lang.String getNameInvalidValue()
public java.lang.String getNamePrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getNameFieldPrintValue()
public java.lang.String getNameRange()
public java.lang.String getNameValidityCheck()
public java.lang.String getNameMetatype()
public java.lang.String getDefaultTemplate()
public void setDefaultTemplate(java.lang.String defaultTemplate)
public void setDefaultTemplate(java.lang.Object defaultTemplate)
public static boolean getDefaultTemplateFlag(int fieldflag)
public static int getDefaultTemplateLengthNorm()
public static int getDefaultTemplateLengthMax()
public static java.lang.String getDefaultTemplateDefaultValue()
public static java.lang.String getDefaultTemplateInvalidValue()
public java.lang.String getDefaultTemplatePrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getDefaultTemplateFieldPrintValue()
public java.lang.String getDefaultTemplateRange()
public java.lang.String getDefaultTemplateValidityCheck()
public java.lang.String getDefaultTemplateMetatype()
public int getDefaultSecurity()
public void setDefaultSecurity(int defaultSecurity)
public java.lang.String defaultSecurityValueToLabel(int val)
public int defaultSecurityLabelToValue(java.lang.String label)
public static java.lang.String[] getDefaultSecurityPrintVals()
public static java.lang.String[] getDefaultSecurityKeyVals()
public static java.lang.String[] getDefaultSecurityActualVals()
public static java.lang.String defaultSecurityPrint2Key(java.lang.String printVal)
getDefaultSecurityPrintVals
and getDefaultSecurityKeyVals methods for details.
public static java.lang.String defaultSecurityPrint2Actual(java.lang.String printVal)
getDefaultSecurityPrintVals
and getDefaultSecurityActualVals methods for details.
public static java.lang.String defaultSecurityActual2Print(java.lang.String actualVal)
getDefaultSecurityActualVals
and getDefaultSecurityPrintVals methods for details.
public static java.lang.String getDefaultSecurityEnumSummary()
public boolean isDefaultSecurityNormal()
public boolean isDefaultSecuritySecure()
public static boolean getDefaultSecurityFlag(int fieldflag)
public static int getDefaultSecurityDefaultValue()
public static int getDefaultSecurityInvalidValue()
public java.lang.String getDefaultSecurityPrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getDefaultSecurityFieldPrintValue()
public java.lang.String getDefaultSecurityRange()
public java.lang.String getDefaultSecurityValidityCheck()
public java.lang.String getDefaultSecurityMetatype()
public long getPublicAuthUserID()
public void setPublicAuthUserID(long publicAuthUserID)
public static boolean getPublicAuthUserIDFlag(int fieldflag)
public static long getPublicAuthUserIDDefaultValue()
public static long getPublicAuthUserIDInvalidValue()
public java.lang.String getPublicAuthUserIDPrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getPublicAuthUserIDFieldPrintValue()
public java.lang.String getPublicAuthUserIDRange()
public java.lang.String getPublicAuthUserIDValidityCheck()
public java.lang.String getPublicAuthUserIDMetatype()
public java.lang.String getWelcomeTemplate()
public void setWelcomeTemplate(java.lang.String welcomeTemplate)
public void setWelcomeTemplate(java.lang.Object welcomeTemplate)
public static boolean getWelcomeTemplateFlag(int fieldflag)
public static int getWelcomeTemplateLengthNorm()
public static int getWelcomeTemplateLengthMax()
public static java.lang.String getWelcomeTemplateDefaultValue()
public static java.lang.String getWelcomeTemplateInvalidValue()
public java.lang.String getWelcomeTemplatePrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getWelcomeTemplateFieldPrintValue()
public java.lang.String getWelcomeTemplateRange()
public java.lang.String getWelcomeTemplateValidityCheck()
public java.lang.String getWelcomeTemplateMetatype()
public int getInitialDisplay()
public void setInitialDisplay(int initialDisplay)
public java.lang.String initialDisplayValueToLabel(int val)
public int initialDisplayLabelToValue(java.lang.String label)
public static java.lang.String[] getInitialDisplayPrintVals()
public static java.lang.String[] getInitialDisplayKeyVals()
public static java.lang.String[] getInitialDisplayActualVals()
public static java.lang.String initialDisplayPrint2Key(java.lang.String printVal)
getInitialDisplayPrintVals
and getInitialDisplayKeyVals methods for details.
public static java.lang.String initialDisplayPrint2Actual(java.lang.String printVal)
getInitialDisplayPrintVals
and getInitialDisplayActualVals methods for details.
public static java.lang.String initialDisplayActual2Print(java.lang.String actualVal)
getInitialDisplayActualVals
and getInitialDisplayPrintVals methods for details.
public static java.lang.String getInitialDisplayEnumSummary()
public static boolean getInitialDisplayFlag(int fieldflag)
public static int getInitialDisplayDefaultValue()
public static int getInitialDisplayInvalidValue()
public java.lang.String getInitialDisplayPrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getInitialDisplayFieldPrintValue()
public java.lang.String getInitialDisplayRange()
public java.lang.String getInitialDisplayValidityCheck()
public java.lang.String getInitialDisplayMetatype()
public java.lang.String getLoginTemplate()
public void setLoginTemplate(java.lang.String loginTemplate)
public void setLoginTemplate(java.lang.Object loginTemplate)
public static boolean getLoginTemplateFlag(int fieldflag)
public static int getLoginTemplateLengthNorm()
public static int getLoginTemplateLengthMax()
public static java.lang.String getLoginTemplateDefaultValue()
public static java.lang.String getLoginTemplateInvalidValue()
public java.lang.String getLoginTemplatePrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getLoginTemplateFieldPrintValue()
public java.lang.String getLoginTemplateRange()
public java.lang.String getLoginTemplateValidityCheck()
public java.lang.String getLoginTemplateMetatype()
public java.lang.String getErrorTemplate()
public void setErrorTemplate(java.lang.String errorTemplate)
public void setErrorTemplate(java.lang.Object errorTemplate)
public static boolean getErrorTemplateFlag(int fieldflag)
public static int getErrorTemplateLengthNorm()
public static int getErrorTemplateLengthMax()
public static java.lang.String getErrorTemplateDefaultValue()
public static java.lang.String getErrorTemplateInvalidValue()
public java.lang.String getErrorTemplatePrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getErrorTemplateFieldPrintValue()
public java.lang.String getErrorTemplateRange()
public java.lang.String getErrorTemplateValidityCheck()
public java.lang.String getErrorTemplateMetatype()
public java.lang.String[] getEntryPoints()
public void setEntryPoints(java.lang.String[] entryPoints)
public void addEntryPoints(java.lang.String element)
public void addEntryPoints(java.lang.String[] elements)
public java.lang.String getEntryPoints(int index)
public void setEntryPoints(int index,
java.lang.String value)
public void insertEntryPoints(int index,
java.lang.String value)
public java.lang.String removeEntryPoints(int index)
public boolean removeEntryPointsValue(java.lang.String value)
public void clearEntryPoints()
public boolean entryPointsContains(java.lang.String val)
public int entryPointsIndexOf(java.lang.String val)
public int sizeofEntryPoints()
public static boolean getEntryPointsFlag(int fieldflag)
public static int getEntryPointsLengthNorm()
public static int getEntryPointsLengthMax()
public static java.lang.String[] getEntryPointsDefaultValue()
public static java.lang.String getEntryPointsElementInvalidValue()
public static java.lang.String[] getEntryPointsInvalidValue()
public java.lang.String getEntryPointsRange()
public Screen[] resolveEntryPointsReferencesNonCrit(org.sandev.basics.util.NameLookup lookup,
org.sandev.basics.util.AuthUser au)
public Screen[] resolveEntryPointsReferences(org.sandev.basics.util.NameLookup lookup,
org.sandev.basics.util.AuthUser au)
throws org.sandev.basics.structs.SandException
org.sandev.basics.structs.SandExceptionpublic java.lang.String getEntryPointsValidityCheck()
public java.lang.String getEntryPointsMetatype()
public Screen[] getScreens()
public void setScreens(Screen[] screens)
public void setScreens(java.lang.Object[] screens)
public void addScreens(Screen element)
public void addScreens(Screen[] elements)
public Screen getScreens(int index)
public void setScreens(int index,
Screen value)
public void insertScreens(int index,
Screen value)
public Screen removeScreens(int index)
public boolean removeScreensValue(Screen value)
public void clearScreens()
public boolean screensContains(Screen val)
public int screensIndexOf(Screen val)
public int sizeofScreens()
public static boolean getScreensFlag(int fieldflag)
public static Screen[] getScreensDefaultValue()
public static Screen getScreensElementInvalidValue()
public static Screen[] getScreensInvalidValue()
public java.lang.String getScreensRange()
public java.lang.String getScreensValidityCheck()
public java.lang.String getScreensMetatype()
public java.lang.String[] getLocaleLanguages()
public void setLocaleLanguages(java.lang.String[] localeLanguages)
public void addLocaleLanguages(java.lang.String element)
public void addLocaleLanguages(java.lang.String[] elements)
public java.lang.String getLocaleLanguages(int index)
public void setLocaleLanguages(int index,
java.lang.String value)
public void insertLocaleLanguages(int index,
java.lang.String value)
public java.lang.String removeLocaleLanguages(int index)
public boolean removeLocaleLanguagesValue(java.lang.String value)
public void clearLocaleLanguages()
public boolean localeLanguagesContains(java.lang.String val)
public int localeLanguagesIndexOf(java.lang.String val)
public int sizeofLocaleLanguages()
public static boolean getLocaleLanguagesFlag(int fieldflag)
public static int getLocaleLanguagesLengthNorm()
public static int getLocaleLanguagesLengthMax()
public static java.lang.String[] getLocaleLanguagesDefaultValue()
public static java.lang.String getLocaleLanguagesElementInvalidValue()
public static java.lang.String[] getLocaleLanguagesInvalidValue()
public java.lang.String getLocaleLanguagesRange()
public java.lang.String getLocaleLanguagesValidityCheck()
public java.lang.String getLocaleLanguagesMetatype()
public java.lang.String[] getLocaleCountries()
public void setLocaleCountries(java.lang.String[] localeCountries)
public void addLocaleCountries(java.lang.String element)
public void addLocaleCountries(java.lang.String[] elements)
public java.lang.String getLocaleCountries(int index)
public void setLocaleCountries(int index,
java.lang.String value)
public void insertLocaleCountries(int index,
java.lang.String value)
public java.lang.String removeLocaleCountries(int index)
public boolean removeLocaleCountriesValue(java.lang.String value)
public void clearLocaleCountries()
public boolean localeCountriesContains(java.lang.String val)
public int localeCountriesIndexOf(java.lang.String val)
public int sizeofLocaleCountries()
public static boolean getLocaleCountriesFlag(int fieldflag)
public static int getLocaleCountriesLengthNorm()
public static int getLocaleCountriesLengthMax()
public static java.lang.String[] getLocaleCountriesDefaultValue()
public static java.lang.String getLocaleCountriesElementInvalidValue()
public static java.lang.String[] getLocaleCountriesInvalidValue()
public java.lang.String getLocaleCountriesRange()
public java.lang.String getLocaleCountriesValidityCheck()
public java.lang.String getLocaleCountriesMetatype()
public java.lang.String[] getLocaleVariants()
public void setLocaleVariants(java.lang.String[] localeVariants)
public void addLocaleVariants(java.lang.String element)
public void addLocaleVariants(java.lang.String[] elements)
public java.lang.String getLocaleVariants(int index)
public void setLocaleVariants(int index,
java.lang.String value)
public void insertLocaleVariants(int index,
java.lang.String value)
public java.lang.String removeLocaleVariants(int index)
public boolean removeLocaleVariantsValue(java.lang.String value)
public void clearLocaleVariants()
public boolean localeVariantsContains(java.lang.String val)
public int localeVariantsIndexOf(java.lang.String val)
public int sizeofLocaleVariants()
public static boolean getLocaleVariantsFlag(int fieldflag)
public static int getLocaleVariantsLengthNorm()
public static int getLocaleVariantsLengthMax()
public static java.lang.String[] getLocaleVariantsDefaultValue()
public static java.lang.String getLocaleVariantsElementInvalidValue()
public static java.lang.String[] getLocaleVariantsInvalidValue()
public java.lang.String getLocaleVariantsRange()
public java.lang.String getLocaleVariantsValidityCheck()
public java.lang.String getLocaleVariantsMetatype()
public int getSandTransmitStatus()
getSandTransmitStatus in interface org.sandev.basics.structs.SandTransmitMessagepublic void setSandTransmitStatus(int sandTransmitStatus)
setSandTransmitStatus in interface org.sandev.basics.structs.SandTransmitMessagepublic static boolean getSandTransmitStatusFlag(int fieldflag)
public static int getSandTransmitStatusDefaultValue()
public static int getSandTransmitStatusInvalidValue()
public java.lang.String getSandTransmitStatusPrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getSandTransmitStatusFieldPrintValue()
public java.lang.String getSandTransmitStatusRange()
public java.lang.String getSandTransmitStatusValidityCheck()
public java.lang.String getSandTransmitStatusMetatype()
public java.lang.String getSandTransmitErrorMessage()
getSandTransmitErrorMessage in interface org.sandev.basics.structs.SandTransmitMessagepublic void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)
setSandTransmitErrorMessage in interface org.sandev.basics.structs.SandTransmitMessagepublic void setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)
public static boolean getSandTransmitErrorMessageFlag(int fieldflag)
public static int getSandTransmitErrorMessageLengthNorm()
public static int getSandTransmitErrorMessageLengthMax()
public static java.lang.String getSandTransmitErrorMessageDefaultValue()
public static java.lang.String getSandTransmitErrorMessageInvalidValue()
public java.lang.String getSandTransmitErrorMessagePrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getSandTransmitErrorMessageFieldPrintValue()
public java.lang.String getSandTransmitErrorMessageRange()
public java.lang.String getSandTransmitErrorMessageValidityCheck()
public java.lang.String getSandTransmitErrorMessageMetatype()
public int getSandTransmissionCount()
getSandTransmissionCount in interface org.sandev.basics.structs.SandTransmitMessagepublic void setSandTransmissionCount(int sandTransmissionCount)
setSandTransmissionCount in interface org.sandev.basics.structs.SandTransmitMessagepublic static boolean getSandTransmissionCountFlag(int fieldflag)
public static int getSandTransmissionCountDefaultValue()
public static int getSandTransmissionCountInvalidValue()
public java.lang.String getSandTransmissionCountPrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getSandTransmissionCountFieldPrintValue()
public java.lang.String getSandTransmissionCountRange()
public java.lang.String getSandTransmissionCountValidityCheck()
public java.lang.String getSandTransmissionCountMetatype()
public long getSandTransmitAuthID()
getSandTransmitAuthID in interface org.sandev.basics.structs.SandTransmitMessagepublic void setSandTransmitAuthID(long sandTransmitAuthID)
setSandTransmitAuthID in interface org.sandev.basics.structs.SandTransmitMessagepublic static boolean getSandTransmitAuthIDFlag(int fieldflag)
public static long getSandTransmitAuthIDDefaultValue()
public static long getSandTransmitAuthIDInvalidValue()
public java.lang.String getSandTransmitAuthIDPrintValue()
Used for debug output, and as an initial value for
transformation and formatting.
public java.lang.String getSandTransmitAuthIDFieldPrintValue()
public java.lang.String getSandTransmitAuthIDRange()
public java.lang.String getSandTransmitAuthIDValidityCheck()
public java.lang.String getSandTransmitAuthIDMetatype()
public void init()
public java.lang.String getShortName()
getShortName in interface org.sandev.basics.structs.SandMessagepublic org.sandev.basics.structs.SandQueryMessage getQueryMessage()
getQueryMessage in interface org.sandev.basics.structs.SandMessagepublic org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()
getCollectionMessage in interface org.sandev.basics.structs.SandMessagepublic org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()
getUpdateMessage in interface org.sandev.basics.structs.SandMessagepublic org.sandev.basics.structs.SandStructMessage getStructMessage()
getStructMessage in interface org.sandev.basics.structs.SandMessagepublic boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)
isEquivalent in interface org.sandev.basics.structs.SandMessage
public void generalModifier(int action,
java.lang.String field,
int index,
java.lang.Object val)
throws org.sandev.basics.structs.SandException
generalModifier in interface org.sandev.basics.structs.SandInstanceMessageorg.sandev.basics.structs.SandExceptionpublic org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)
generalDereference in interface org.sandev.basics.structs.SandInstanceMessagepublic java.lang.Object generalAccessor(java.lang.String fieldspec)
generalAccessor in interface org.sandev.basics.structs.SandInstanceMessagepublic java.lang.String[] getDisplayFields()
getDisplayFields in interface org.sandev.basics.structs.SandInstanceMessagepublic java.lang.String[] getDisplayValues()
getDisplayValues in interface org.sandev.basics.structs.SandInstanceMessage
public java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup,
org.sandev.basics.util.AuthUser user,
java.lang.String defaultVal)
getDisplayValues in interface org.sandev.basics.util.Resolvable
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)
public java.lang.String toString()
public java.lang.String[] getAllFields()
getAllFields in interface org.sandev.basics.structs.SandInstanceMessagepublic void defaultField(java.lang.String fieldname)
defaultField in interface org.sandev.basics.structs.SandInstanceMessagepublic org.sandev.basics.structs.SandInstanceMessage cloneMessage()
cloneMessage in interface org.sandev.basics.structs.SandInstanceMessagepublic SandUI cloneSandUI()
public void copyDataFrom(SandUI other)
public void copyFieldValue(java.lang.String fieldName,
org.sandev.basics.structs.SandInstanceMessage other)
copyFieldValue in interface org.sandev.basics.structs.SandInstanceMessagepublic org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)
fieldValidate in interface org.sandev.basics.structs.SandInstanceMessagepublic boolean fieldsValid()
fieldsValid in interface org.sandev.basics.structs.SandInstanceMessage
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
referenceValidate in interface org.sandev.basics.util.Resolvableorg.sandev.basics.structs.SandExceptionpublic org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()
convertToSuperstructClass in interface org.sandev.basics.structs.SandInstanceMessagepublic java.lang.String debugDump(java.lang.String prefix)
debugDump in interface org.sandev.basics.structs.SandInstanceMessage
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||