org.sandev.ui.sandmessages
Class Screen

java.lang.Object
  org.sandev.ui.structs.ScreenStruct
      org.sandev.ui.sandmessages.Screen

All Implemented Interfaces:

org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

public class Screen
extends ScreenStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.ui.structs.ScreenStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:15 PM

Field Summary

static int	SECURITY_DEFAULT Possible value for security
static int	SECURITY_REDIRECT Possible value for security
static int	SECURITY_SECURE Possible value for security

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

links, name, primaryFormIndex, security, template

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

FIELDCHECK_EMPTYSTRINGPRINTVAL, 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_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Constructor Summary

Screen()
Default constructor calls init.

Method Summary

void	addLinks(Link element) Appends a value to links
void	addLinks(Link[] elements) Appends an array of values to links
void	clearLinks() Clears all values from links
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneScreen
Screen	cloneScreen() Make a deep copy of this Screen.
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(Screen other, boolean deepcopy) 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.
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
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
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.
int	getBaseMemoryUse() Return the base memory use for this object.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns a new ScreenCollection instance
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayFieldsPrint() Return an array of the summary field print names for this class.
java.lang.String	getDisplayID() Return the displayID for this message instance
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.
org.sandev.basics.structs.SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
org.sandev.basics.structs.SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
java.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
Link[]	getLinks() Accessor for links.
Link	getLinks(int index) Returns the element at the specified index.
static Link[]	getLinksDefaultValue() Default value for links.
static Link	getLinksElementInvalidValue() Invalid value for linkselement.
java.lang.String	getLinksFieldPrintValue() Return the print name of the links field.
static boolean	getLinksFlag(int fieldflag) Field flag accessor.
static Link[]	getLinksInvalidValue() Invalid value for links.
java.lang.String	getLinksMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLinksPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLinksRange() Return the range specification for this field
java.lang.String	getLinksValidityCheck() 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.
int	getPrimaryFormIndex() Accessor for primaryFormIndex
static int	getPrimaryFormIndexDefaultValue() Default value for primaryFormIndex.
java.lang.String	getPrimaryFormIndexFieldPrintValue() Return the print name of the primaryFormIndex field.
static boolean	getPrimaryFormIndexFlag(int fieldflag) Field flag accessor.
static int	getPrimaryFormIndexInvalidValue() Invalid value for primaryFormIndex.
java.lang.String	getPrimaryFormIndexMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getPrimaryFormIndexPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getPrimaryFormIndexRange() Return the range specification for this field
java.lang.String	getPrimaryFormIndexValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getPrintname() Return the printname of the class
java.lang.String	getPrintnameForField(java.lang.String fieldname) Given a fieldname, return its declared printname if declared.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns a new ScreenQuery instance
int	getSecurity() Accessor for security
static java.lang.String[]	getSecurityActualVals() Return an array of the possible values for this field as Strings.
static int	getSecurityDefaultValue() Default value for security.
static java.lang.String	getSecurityEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getSecurityFieldPrintValue() Return the print name of the security field.
static boolean	getSecurityFlag(int fieldflag) Field flag accessor.
static int	getSecurityInvalidValue() Invalid value for security.
static java.lang.String[]	getSecurityKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getSecurityMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getSecurityPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getSecurityPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSecurityRange() Return the range specification for this field
java.lang.String	getSecurityValidityCheck() 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 Screen instance
java.lang.String	getTemplate() Accessor for template
static java.lang.String	getTemplateDefaultValue() Default value for template.
java.lang.String	getTemplateFieldPrintValue() Return the print name of the template field.
static boolean	getTemplateFlag(int fieldflag) Field flag accessor.
static java.lang.String	getTemplateInvalidValue() Invalid value for template.
static int	getTemplateLengthMax() Maximum template length is 127 characters
static int	getTemplateLengthNorm() Normal template length is 20 characters
java.lang.String	getTemplateMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTemplatePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTemplateRange() Return the range specification for this field
java.lang.String	getTemplateValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns a new ScreenUpdate 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.
void	init() Initialize all fields to their default values
void	insertLinks(int index, Link value) Insert the specified element at the specified index.
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
boolean	linksContains(Link val) Returns true if links contains the specified value.
int	linksIndexOf(Link val) Return the index of the specified value in links, 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.
Link	removeLinks(int index) Remove the element at the specified index and return it.
boolean	removeLinksValue(Link value) Removes the given element from links.
static java.lang.String	securityActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	securityLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	securityLabelToValueStatic(java.lang.String label)
static java.lang.String	securityPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	securityPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	securityValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	securityValueToLabelStatic(int val)
void	setLinks(int index, Link value) Set the value at the index specified.
void	setLinks(Link[] links) Mutator for links
void	setLinks(java.lang.Object[] links) Generic mutator for links
void	setName(java.lang.Object name) Generic mutator for name
void	setName(java.lang.String name) Mutator for name
void	setPrimaryFormIndex(int primaryFormIndex) Mutator for primaryFormIndex
void	setSecurity(int security) Mutator for security
void	setTemplate(java.lang.Object template) Generic mutator for template
void	setTemplate(java.lang.String template) Mutator for template
Screen	shallowCopy() Make a shallow copy of this Screen.
int	sizeofLinks() Returns the size of links.
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

SECURITY_DEFAULT

public static final int SECURITY_DEFAULT

Possible value for security

See Also:

Constant Field Values

SECURITY_SECURE

public static final int SECURITY_SECURE

Possible value for security

See Also:

Constant Field Values

SECURITY_REDIRECT

public static final int SECURITY_REDIRECT

Possible value for security

See Also:

Constant Field Values

Constructor Detail

Screen

public Screen()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

getPrintname in interface org.sandev.basics.structs.SandStructMessage

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.

getTemplate

public java.lang.String getTemplate()

Accessor for template

setTemplate

public void setTemplate(java.lang.String template)

Mutator for template

setTemplate

public void setTemplate(java.lang.Object template)

Generic mutator for template

getTemplateFlag

public static boolean getTemplateFlag(int fieldflag)

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

getTemplateLengthNorm

public static int getTemplateLengthNorm()

Normal template length is 20 characters

getTemplateLengthMax

public static int getTemplateLengthMax()

Maximum template length is 127 characters

getTemplateDefaultValue

public static java.lang.String getTemplateDefaultValue()

Default value for template. Returns ""

getTemplateInvalidValue

public static java.lang.String getTemplateInvalidValue()

Invalid value for template. Returns "INVALID_TEMPLATE_NAME"

getTemplatePrintValue

public java.lang.String getTemplatePrintValue()

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.

getTemplateFieldPrintValue

public java.lang.String getTemplateFieldPrintValue()

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

getTemplateRange

public java.lang.String getTemplateRange()

Return the range specification for this field

getTemplateValidityCheck

public java.lang.String getTemplateValidityCheck()

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.

getTemplateMetatype

public java.lang.String getTemplateMetatype()

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

getSecurity

public int getSecurity()

Accessor for security

setSecurity

public void setSecurity(int security)

Mutator for security

securityValueToLabel

public java.lang.String securityValueToLabel(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.

securityValueToLabelStatic

public static java.lang.String securityValueToLabelStatic(int val)

securityLabelToValue

public int securityLabelToValue(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.

securityLabelToValueStatic

public static int securityLabelToValueStatic(java.lang.String label)

getSecurityPrintVals

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

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.

getSecurityKeyVals

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

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.

getSecurityActualVals

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

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

securityPrint2Key

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

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

securityPrint2Actual

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

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

securityActual2Print

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

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

getSecurityEnumSummary

public static java.lang.String getSecurityEnumSummary()

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

getSecurityFlag

public static boolean getSecurityFlag(int fieldflag)

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

getSecurityDefaultValue

public static int getSecurityDefaultValue()

Default value for security. Returns SECURITY_DEFAULT

getSecurityInvalidValue

public static int getSecurityInvalidValue()

Invalid value for security. Returns -1

getSecurityPrintValue

public java.lang.String getSecurityPrintValue()

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.

getSecurityFieldPrintValue

public java.lang.String getSecurityFieldPrintValue()

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

getSecurityRange

public java.lang.String getSecurityRange()

Return the range specification for this field

getSecurityValidityCheck

public java.lang.String getSecurityValidityCheck()

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.

getSecurityMetatype

public java.lang.String getSecurityMetatype()

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

getLinks

public Link[] getLinks()

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

setLinks

public void setLinks(Link[] links)

Mutator for links

setLinks

public void setLinks(java.lang.Object[] links)

Generic mutator for links

addLinks

public void addLinks(Link element)

Appends a value to links

addLinks

public void addLinks(Link[] elements)

Appends an array of values to links

getLinks

public Link getLinks(int index)

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

setLinks

public void setLinks(int index,
                     Link value)

Set the value at the index specified.

insertLinks

public void insertLinks(int index,
                        Link 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.

removeLinks

public Link removeLinks(int index)

Remove the element at the specified index and return it.

removeLinksValue

public boolean removeLinksValue(Link value)

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

clearLinks

public void clearLinks()

Clears all values from links

linksContains

public boolean linksContains(Link val)

Returns true if links contains the specified value.

linksIndexOf

public int linksIndexOf(Link val)

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

sizeofLinks

public int sizeofLinks()

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

getLinksFlag

public static boolean getLinksFlag(int fieldflag)

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

getLinksDefaultValue

public static Link[] getLinksDefaultValue()

Default value for links. Returns new Link[0]

getLinksElementInvalidValue

public static Link getLinksElementInvalidValue()

Invalid value for linkselement. Returns null

getLinksInvalidValue

public static Link[] getLinksInvalidValue()

Invalid value for links. Returns null

getLinksPrintValue

public java.lang.String getLinksPrintValue()

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.

getLinksFieldPrintValue

public java.lang.String getLinksFieldPrintValue()

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

getLinksRange

public java.lang.String getLinksRange()

Return the range specification for this field

getLinksValidityCheck

public java.lang.String getLinksValidityCheck()

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.

getLinksMetatype

public java.lang.String getLinksMetatype()

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

getPrimaryFormIndex

public int getPrimaryFormIndex()

Accessor for primaryFormIndex

setPrimaryFormIndex

public void setPrimaryFormIndex(int primaryFormIndex)

Mutator for primaryFormIndex

getPrimaryFormIndexFlag

public static boolean getPrimaryFormIndexFlag(int fieldflag)

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

getPrimaryFormIndexDefaultValue

public static int getPrimaryFormIndexDefaultValue()

Default value for primaryFormIndex. Returns 0

getPrimaryFormIndexInvalidValue

public static int getPrimaryFormIndexInvalidValue()

Invalid value for primaryFormIndex. Returns Integer.MIN_VALUE

getPrimaryFormIndexPrintValue

public java.lang.String getPrimaryFormIndexPrintValue()

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.

getPrimaryFormIndexFieldPrintValue

public java.lang.String getPrimaryFormIndexFieldPrintValue()

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

getPrimaryFormIndexRange

public java.lang.String getPrimaryFormIndexRange()

Return the range specification for this field

getPrimaryFormIndexValidityCheck

public java.lang.String getPrimaryFormIndexValidityCheck()

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.

getPrimaryFormIndexMetatype

public java.lang.String getPrimaryFormIndexMetatype()

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 a new ScreenQuery instance

Specified by:

getQueryMessage in interface org.sandev.basics.structs.SandMessage

getCollectionMessage

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

Returns a new ScreenCollection instance

Specified by:

getCollectionMessage in interface org.sandev.basics.structs.SandMessage

getUpdateMessage

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

Returns a new ScreenUpdate instance

Specified by:

getUpdateMessage in interface org.sandev.basics.structs.SandMessage

getStructMessage

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

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

When comparing arrays, it is possible that the array elements may have been set to null as part of authorization filtering or similar unusual circumstances. A null array element is only equivalent to another null array element.

Specified by:

isEquivalent in interface org.sandev.basics.structs.SandMessage

getBaseMemoryUse

public int getBaseMemoryUse()

Return the base memory use for this object. This number is a minimum value for estimation purposes, see the comments in the SandStructMessage declaration for details.

Specified by:

getBaseMemoryUse 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

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

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

Specified by:

getDisplayFieldsPrint in interface org.sandev.basics.structs.SandInstanceMessage

getLayoutXML

public java.lang.String getLayoutXML()

Return the fieldlayout XML or null if not defined.

Specified by:

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

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

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

getContainedMessageFields 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

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)

Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

Specified by:

getPrintnameForField in interface org.sandev.basics.structs.SandInstanceMessage

cloneMessage

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

Calls cloneScreen

Specified by:

cloneMessage in interface org.sandev.basics.structs.SandInstanceMessage

cloneScreen

public Screen cloneScreen()

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

shallowCopy

public Screen shallowCopy()

Make a shallow copy of this Screen. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(Screen other,
                         boolean deepcopy)

Copy all the data from the specified instance. If the other instance is null then this method does nothing. If deepcopy is specified then contained structs are copied, otherwise not. The one field this does not copy is instanceWriteAccess, since you need the copied instance to be writeable.

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

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

getDisplayID in interface org.sandev.basics.structs.SandInstanceMessage

getInstance

public org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname,
                                                                long id)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

getInstance in interface org.sandev.basics.structs.SandStructMessage

getInstance

public org.sandev.basics.structs.SandInstanceMessage getInstance(java.lang.String classname,
                                                                 java.lang.String fieldname,
                                                                 java.lang.String value)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

getInstance in interface org.sandev.basics.structs.SandStructMessage

find

public org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)

Return a matching collection of all directly contained instances matching the given query.

Specified by:

find in interface org.sandev.basics.structs.SandStructMessage

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object