org.sandev.basics.sandmessages
Class UIFormControl

java.lang.Object
  org.sandev.basics.structs.UIFormControlStruct
      org.sandev.basics.sandmessages.UIFormControl

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class UIFormControl
extends UIFormControlStruct
implements SandStructMessage, Resolvable

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

Field Summary

Fields inherited from class org.sandev.basics.structs.UIFormControlStruct

directives, selectionField

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

UIFormControl()
Default constructor calls init.

Method Summary

void	addDirectives(UIDisplayDirective element) Appends a value to directives
void	addDirectives(UIDisplayDirective[] elements) Appends an array of values to directives
void	clearDirectives() Clears all values from directives
SandInstanceMessage	cloneMessage() Calls cloneUIFormControl
UIFormControl	cloneUIFormControl() Make a deep copy of this UIFormControl.
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(UIFormControl other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, 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	directivesContains(UIDisplayDirective val) Returns true if directives contains the specified value.
int	directivesIndexOf(UIDisplayDirective val) Return the index of the specified value in directives, 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
SandAttrVal[]	fieldValidate(SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
SandCollectionMessage	find(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.
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.
SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
UIDisplayDirective[]	getDirectives() Accessor for directives.
UIDisplayDirective	getDirectives(int index) Returns the element at the specified index.
static UIDisplayDirective[]	getDirectivesDefaultValue() Default value for directives.
static UIDisplayDirective	getDirectivesElementInvalidValue() Invalid value for directiveselement.
java.lang.String	getDirectivesFieldPrintValue() Return the print name of the directives field.
static boolean	getDirectivesFlag(int fieldflag) Field flag accessor.
static UIDisplayDirective[]	getDirectivesInvalidValue() Invalid value for directives.
java.lang.String	getDirectivesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDirectivesPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDirectivesRange() Return the range specification for this field
java.lang.String	getDirectivesValidityCheck() 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[]	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(IDLookup lookup, AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
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.
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.
SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getSelectionField() Accessor for selectionField
static java.lang.String	getSelectionFieldDefaultValue() Default value for selectionField.
java.lang.String	getSelectionFieldFieldPrintValue() Return the print name of the selectionField field.
static boolean	getSelectionFieldFlag(int fieldflag) Field flag accessor.
static java.lang.String	getSelectionFieldInvalidValue() Invalid value for selectionField.
static int	getSelectionFieldLengthMax() Maximum selectionField length is 70 characters
static int	getSelectionFieldLengthNorm() Normal selectionField length is 30 characters
java.lang.String	getSelectionFieldMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSelectionFieldPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSelectionFieldRange() Return the range specification for this field
java.lang.String	getSelectionFieldValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getShortName() Returns the unqualified name of this message.
SandStructMessage	getStructMessage() Returns a new UIFormControl instance
SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, IDLookup lookup, 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	insertDirectives(int index, UIDisplayDirective value) Insert the specified element at the specified index.
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au) Validate the references as specified in the Resolvable interface.
UIDisplayDirective	removeDirectives(int index) Remove the element at the specified index and return it.
boolean	removeDirectivesValue(UIDisplayDirective value) Removes the given element from directives.
void	setDirectives(int index, UIDisplayDirective value) Set the value at the index specified.
void	setDirectives(java.lang.Object[] directives) Generic mutator for directives
void	setDirectives(UIDisplayDirective[] directives) Mutator for directives
void	setSelectionField(java.lang.Object selectionField) Generic mutator for selectionField
void	setSelectionField(java.lang.String selectionField) Mutator for selectionField
UIFormControl	shallowCopy() Make a shallow copy of this UIFormControl.
int	sizeofDirectives() Returns the size of directives.
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

Constructor Detail

UIFormControl

public UIFormControl()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

getPrintname in interface 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 SandInstanceMessage

getSelectionField

public java.lang.String getSelectionField()

Accessor for selectionField

setSelectionField

public void setSelectionField(java.lang.String selectionField)

Mutator for selectionField

setSelectionField

public void setSelectionField(java.lang.Object selectionField)

Generic mutator for selectionField

getSelectionFieldFlag

public static boolean getSelectionFieldFlag(int fieldflag)

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

getSelectionFieldLengthNorm

public static int getSelectionFieldLengthNorm()

Normal selectionField length is 30 characters

getSelectionFieldLengthMax

public static int getSelectionFieldLengthMax()

Maximum selectionField length is 70 characters

getSelectionFieldDefaultValue

public static java.lang.String getSelectionFieldDefaultValue()

Default value for selectionField. Returns ""

getSelectionFieldInvalidValue

public static java.lang.String getSelectionFieldInvalidValue()

Invalid value for selectionField. Returns null

getSelectionFieldPrintValue

public java.lang.String getSelectionFieldPrintValue()

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.

getSelectionFieldFieldPrintValue

public java.lang.String getSelectionFieldFieldPrintValue()

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

getSelectionFieldRange

public java.lang.String getSelectionFieldRange()

Return the range specification for this field

getSelectionFieldValidityCheck

public java.lang.String getSelectionFieldValidityCheck()

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.

getSelectionFieldMetatype

public java.lang.String getSelectionFieldMetatype()

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

getDirectives

public UIDisplayDirective[] getDirectives()

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

setDirectives

public void setDirectives(UIDisplayDirective[] directives)

Mutator for directives

setDirectives

public void setDirectives(java.lang.Object[] directives)

Generic mutator for directives

addDirectives

public void addDirectives(UIDisplayDirective element)

Appends a value to directives

addDirectives

public void addDirectives(UIDisplayDirective[] elements)

Appends an array of values to directives

getDirectives

public UIDisplayDirective getDirectives(int index)

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

setDirectives

public void setDirectives(int index,
                          UIDisplayDirective value)

Set the value at the index specified.

insertDirectives

public void insertDirectives(int index,
                             UIDisplayDirective 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.

removeDirectives

public UIDisplayDirective removeDirectives(int index)

Remove the element at the specified index and return it.

removeDirectivesValue

public boolean removeDirectivesValue(UIDisplayDirective value)

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

clearDirectives

public void clearDirectives()

Clears all values from directives

directivesContains

public boolean directivesContains(UIDisplayDirective val)

Returns true if directives contains the specified value.

directivesIndexOf

public int directivesIndexOf(UIDisplayDirective val)

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

sizeofDirectives

public int sizeofDirectives()

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

getDirectivesFlag

public static boolean getDirectivesFlag(int fieldflag)

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

getDirectivesDefaultValue

public static UIDisplayDirective[] getDirectivesDefaultValue()

Default value for directives. Returns new UIDisplayDirective[0]

getDirectivesElementInvalidValue

public static UIDisplayDirective getDirectivesElementInvalidValue()

Invalid value for directiveselement. Returns null

getDirectivesInvalidValue

public static UIDisplayDirective[] getDirectivesInvalidValue()

Invalid value for directives. Returns null

getDirectivesPrintValue

public java.lang.String getDirectivesPrintValue()

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.

getDirectivesFieldPrintValue

public java.lang.String getDirectivesFieldPrintValue()

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

getDirectivesRange

public java.lang.String getDirectivesRange()

Return the range specification for this field

getDirectivesValidityCheck

public java.lang.String getDirectivesValidityCheck()

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.

getDirectivesMetatype

public java.lang.String getDirectivesMetatype()

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 SandMessage

getQueryMessage

public SandQueryMessage getQueryMessage()

Returns null

Specified by:

getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()

Returns null

Specified by:

getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()

Returns null

Specified by:

getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new UIFormControl instance

Specified by:

getStructMessage in interface SandMessage

isEquivalent

public boolean isEquivalent(SandMessage sm)

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

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

Specified by:

isEquivalent in interface 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 SandMessage

generalModifier

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

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

generalModifier in interface SandInstanceMessage

Throws:

SandException

generalDereference

public SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalDereference in interface SandInstanceMessage

generalAccessor

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

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalAccessor in interface SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

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

Specified by:

getDisplayFields in interface SandInstanceMessage

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

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

Specified by:

getDisplayFieldsPrint in interface SandInstanceMessage

getLayoutXML

public java.lang.String getLayoutXML()

Return the fieldlayout XML or null if not defined.

Specified by:

getLayoutXML in interface 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 SandInstanceMessage

getDisplayValues

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

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

Specified by:

getDisplayValues in interface Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             IDLookup lookup,
                                             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 SandInstanceMessage

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

getContainedMessageFields in interface SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

defaultField in interface 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 SandInstanceMessage

cloneMessage

public SandInstanceMessage cloneMessage()

Calls cloneUIFormControl

Specified by:

cloneMessage in interface SandInstanceMessage

cloneUIFormControl

public UIFormControl cloneUIFormControl()

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

shallowCopy

public UIFormControl shallowCopy()

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

copyDataFrom

public void copyDataFrom(UIFormControl 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,
                           SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

copyFieldValue in interface SandInstanceMessage

fieldValidate

public SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldValidate in interface SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldsValid in interface SandInstanceMessage

referenceValidate

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

Validate the references as specified in the Resolvable interface.

Specified by:

referenceValidate in interface Resolvable

Throws:

SandException

convertToSuperstructClass

public 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 SandInstanceMessage

debugDump

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

Dump this instance into a debug printable string.

Specified by:

debugDump in interface SandInstanceMessage

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

getDisplayID in interface SandInstanceMessage

getInstance

public 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 SandStructMessage

getInstance

public 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 SandStructMessage

find

public SandCollectionMessage find(SandQueryMessage sqm)

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

Specified by:

find in interface 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