Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.sandev.basics.sandmessages
Class UIFormInitializer

java.lang.Object
  extended by org.sandev.basics.structs.UIFormInitializerStruct
      extended by org.sandev.basics.sandmessages.UIFormInitializer
All Implemented Interfaces:
SandInstanceMessage, SandMessage, SandStructMessage, Resolvable
Direct Known Subclasses:
UIFormContext
public class UIFormInitializer
extends UIFormInitializerStruct
implements SandStructMessage, Resolvable

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

Field Summary
static int ACTION_ADD
          If authorized, the user may create a new object instance.
static int ACTION_CANCEL
          A "cancel" action means that the user wishes to abort the processing they started and return to where they were before.
static int ACTION_COLLAPSE
          Collapse the array display to hide the elements from view
static int ACTION_CUSTOM
          Indicates a custom user action has been taken.
static int ACTION_DELETE
          Delete the contained object or contained array element.
static int ACTION_DEREF
          A "deref" action is similar to a "drilldown" except it is a shift to the referenced object.
static int ACTION_DRILLDOWN
          A "drilldown" action is a movement from a listed object instance to one of it's contained objects.
static int ACTION_EDIT
          If authorized, the user may select to edit the displayed instance.
static int ACTION_EXPAND
          Expand the array display to show the elements in it.
static int ACTION_FIND
          If supported, the user may select to find new instances of the current object type or a different object type.
static int ACTION_HELP
          A "help" action indicates that the user would like additional information about the form they are working with.
static int ACTION_INIT
          Indicates that this context should be initialized.
static int ACTION_MOVEDOWN
          Move the contained array element down one position.
static int ACTION_MOVEUP
          Move the contained array element up one position.
static int ACTION_NEW
          Create a new instance of the referenced object type, and set the current reference to the new instance.
static int ACTION_NEXT
          If a collection object is being listed, and there are more elements to display (either actually in the collection, or because the collection is not complete and more items can be retrieved), then the user has an option to list the next page of collection elements.
static int ACTION_OK
          An "ok" action means the user is done with the current form.
static int ACTION_PAGETO
          If a collection object is being listed with more than one page of values available, then the user has the option to jump to a specific result page.
static int ACTION_PARENT
          The opposite of a "drilldown".
static int ACTION_PREVIOUS
          If a collection object is being listed, and there are elements before the first element shown (either actually in the collection, or because the collection does not start with the first element), then the user has an option to list the previous page of collection elements.
static int ACTION_REMOVE
          Remove the reference or referenced array element.
static int ACTION_SAVE
          A "save" action means write all changes to disk.
static int ACTION_SELECT
          A "select" action is used in LISTING mode if we are in the process of adding a reference to an existing object instance, and we are displaying a collection of possible objects as the result of a query.
static int ACTION_UNDEFINED
          No action was taken.
static int MODESTACK_ADDING
          Possible value for modeStack
static int MODESTACK_FINDING
          Possible value for modeStack
static int MODESTACK_LISTING
          Possible value for modeStack
static int MODESTACK_UNDEFINED
          Possible value for modeStack
static int MODESTACK_UPDATING
          Possible value for modeStack
 
Fields inherited from class org.sandev.basics.structs.UIFormInitializerStruct
action, currClass, currInst, findCollection, findCollIndex, findCollMaxDisplay, findKeys, findQuery, formControl, modeStack, outputText, position, rootMsg, userQuery
 
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
UIFormInitializer()
          Default constructor calls init.
 
Method Summary
static java.lang.String actionActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int actionLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static int actionLabelToValueStatic(java.lang.String label)
           
static java.lang.String actionPrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String actionPrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String actionValueToLabel(int val)
          Given a value, return the declared label for it.
static java.lang.String actionValueToLabelStatic(int val)
           
 void addFindKeys(java.lang.String element)
          Appends a value to findKeys
 void addFindKeys(java.lang.String[] elements)
          Appends an array of values to findKeys
 void addModeStack(int element)
          Appends a value to modeStack
 void addModeStack(int[] elements)
          Appends an array of values to modeStack
 void addOutputText(ErrorInfo element)
          Appends a value to outputText
 void addOutputText(ErrorInfo[] elements)
          Appends an array of values to outputText
 void addPosition(java.lang.String element)
          Appends a value to position
 void addPosition(java.lang.String[] elements)
          Appends an array of values to position
 void clearFindKeys()
          Clears all values from findKeys
 void clearModeStack()
          Clears all values from modeStack
 void clearOutputText()
          Clears all values from outputText
 void clearPosition()
          Clears all values from position
 SandInstanceMessage cloneMessage()
          Calls cloneUIFormInitializer
 UIFormInitializer cloneUIFormInitializer()
          Make a deep copy of this UIFormInitializer.
 SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(UIFormInitializer 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 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.
 boolean findKeysContains(java.lang.String val)
          Returns true if findKeys contains the specified value.
 int findKeysIndexOf(java.lang.String val)
          Return the index of the specified value in findKeys, or -1 if not found.
 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.
 int getAction()
          Accessor for action
static java.lang.String[] getActionActualVals()
          Return an array of the possible values for this field as Strings.
static int getActionDefaultValue()
          Default value for action.
static java.lang.String getActionEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getActionFieldPrintValue()
          Return the print name of the action field.
static boolean getActionFlag(int fieldflag)
          Field flag accessor.
static int getActionInvalidValue()
          Invalid value for action.
static java.lang.String[] getActionKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getActionMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getActionPrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getActionPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getActionRange()
          Return the range specification for this field
 java.lang.String getActionValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 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.
 java.lang.String getCurrClass()
          Accessor for currClass
static java.lang.String getCurrClassDefaultValue()
          Default value for currClass.
 java.lang.String getCurrClassFieldPrintValue()
          Return the print name of the currClass field.
static boolean getCurrClassFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getCurrClassInvalidValue()
          Invalid value for currClass.
static int getCurrClassLengthMax()
          Maximum currClass length is 70 characters
static int getCurrClassLengthNorm()
          Normal currClass length is 30 characters
 java.lang.String getCurrClassMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getCurrClassPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getCurrClassRange()
          Return the range specification for this field
 java.lang.String getCurrClassValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 SandInstanceMessage getCurrInst()
          Accessor for currInst
static SandInstanceMessage getCurrInstDefaultValue()
          Default value for currInst.
 java.lang.String getCurrInstFieldPrintValue()
          Return the print name of the currInst field.
static boolean getCurrInstFlag(int fieldflag)
          Field flag accessor.
static SandInstanceMessage getCurrInstInvalidValue()
          Invalid value for currInst.
 java.lang.String getCurrInstMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getCurrInstPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getCurrInstRange()
          Return the range specification for this field
 java.lang.String getCurrInstValidityCheck()
          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.
 SandCollectionMessage getFindCollection()
          Accessor for findCollection
static SandCollectionMessage getFindCollectionDefaultValue()
          Default value for findCollection.
 java.lang.String getFindCollectionFieldPrintValue()
          Return the print name of the findCollection field.
static boolean getFindCollectionFlag(int fieldflag)
          Field flag accessor.
static SandCollectionMessage getFindCollectionInvalidValue()
          Invalid value for findCollection.
 java.lang.String getFindCollectionMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getFindCollectionPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getFindCollectionRange()
          Return the range specification for this field
 java.lang.String getFindCollectionValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getFindCollIndex()
          Accessor for findCollIndex
static int getFindCollIndexDefaultValue()
          Default value for findCollIndex.
 java.lang.String getFindCollIndexFieldPrintValue()
          Return the print name of the findCollIndex field.
static boolean getFindCollIndexFlag(int fieldflag)
          Field flag accessor.
static int getFindCollIndexInvalidValue()
          Invalid value for findCollIndex.
 java.lang.String getFindCollIndexMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getFindCollIndexPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getFindCollIndexRange()
          Return the range specification for this field
 java.lang.String getFindCollIndexValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getFindCollMaxDisplay()
          Accessor for findCollMaxDisplay
static int getFindCollMaxDisplayDefaultValue()
          Default value for findCollMaxDisplay.
 java.lang.String getFindCollMaxDisplayFieldPrintValue()
          Return the print name of the findCollMaxDisplay field.
static boolean getFindCollMaxDisplayFlag(int fieldflag)
          Field flag accessor.
static int getFindCollMaxDisplayInvalidValue()
          Invalid value for findCollMaxDisplay.
 java.lang.String getFindCollMaxDisplayMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getFindCollMaxDisplayPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getFindCollMaxDisplayRange()
          Return the range specification for this field
 java.lang.String getFindCollMaxDisplayValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String[] getFindKeys()
          Accessor for findKeys.
 java.lang.String getFindKeys(int index)
          Returns the element at the specified index.
static java.lang.String[] getFindKeysDefaultValue()
          Default value for findKeys.
static java.lang.String getFindKeysElementInvalidValue()
          Invalid value for findKeyselement.
 java.lang.String getFindKeysFieldPrintValue()
          Return the print name of the findKeys field.
static boolean getFindKeysFlag(int fieldflag)
          Field flag accessor.
static java.lang.String[] getFindKeysInvalidValue()
          Invalid value for findKeys.
static int getFindKeysLengthMax()
          Maximum findKeys length is 70 characters
static int getFindKeysLengthNorm()
          Normal findKeys length is 30 characters
 java.lang.String getFindKeysMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getFindKeysPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getFindKeysRange()
          Return the range specification for this field
 java.lang.String getFindKeysValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 SandQueryMessage getFindQuery()
          Accessor for findQuery
static SandQueryMessage getFindQueryDefaultValue()
          Default value for findQuery.
 java.lang.String getFindQueryFieldPrintValue()
          Return the print name of the findQuery field.
static boolean getFindQueryFlag(int fieldflag)
          Field flag accessor.
static SandQueryMessage getFindQueryInvalidValue()
          Invalid value for findQuery.
 java.lang.String getFindQueryMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getFindQueryPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getFindQueryRange()
          Return the range specification for this field
 java.lang.String getFindQueryValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 UIFormControl getFormControl()
          Accessor for formControl
static UIFormControl getFormControlDefaultValue()
          Default value for formControl.
 java.lang.String getFormControlFieldPrintValue()
          Return the print name of the formControl field.
static boolean getFormControlFlag(int fieldflag)
          Field flag accessor.
static UIFormControl getFormControlInvalidValue()
          Invalid value for formControl.
 java.lang.String getFormControlMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getFormControlPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getFormControlRange()
          Return the range specification for this field
 java.lang.String getFormControlValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 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.
 int[] getModeStack()
          Accessor for modeStack.
 int getModeStack(int index)
          Returns the element at the specified index.
static java.lang.String[] getModeStackActualVals()
          Return an array of the possible values for this field as Strings.
static int[] getModeStackDefaultValue()
          Default value for modeStack.
static int getModeStackElementInvalidValue()
          Invalid value for modeStackelement.
static java.lang.String getModeStackEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getModeStackFieldPrintValue()
          Return the print name of the modeStack field.
static boolean getModeStackFlag(int fieldflag)
          Field flag accessor.
static int[] getModeStackInvalidValue()
          Invalid value for modeStack.
static java.lang.String[] getModeStackKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getModeStackMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getModeStackPrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getModeStackPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getModeStackRange()
          Return the range specification for this field
 java.lang.String getModeStackValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 ErrorInfo[] getOutputText()
          Accessor for outputText.
 ErrorInfo getOutputText(int index)
          Returns the element at the specified index.
static ErrorInfo[] getOutputTextDefaultValue()
          Default value for outputText.
static ErrorInfo getOutputTextElementInvalidValue()
          Invalid value for outputTextelement.
 java.lang.String getOutputTextFieldPrintValue()
          Return the print name of the outputText field.
static boolean getOutputTextFlag(int fieldflag)
          Field flag accessor.
static ErrorInfo[] getOutputTextInvalidValue()
          Invalid value for outputText.
 java.lang.String getOutputTextMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getOutputTextPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getOutputTextRange()
          Return the range specification for this field
 java.lang.String getOutputTextValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String[] getPosition()
          Accessor for position.
 java.lang.String getPosition(int index)
          Returns the element at the specified index.
static java.lang.String[] getPositionDefaultValue()
          Default value for position.
static java.lang.String getPositionElementInvalidValue()
          Invalid value for positionelement.
 java.lang.String getPositionFieldPrintValue()
          Return the print name of the position field.
static boolean getPositionFlag(int fieldflag)
          Field flag accessor.
static java.lang.String[] getPositionInvalidValue()
          Invalid value for position.
static int getPositionLengthMax()
          Maximum position length is 70 characters
static int getPositionLengthNorm()
          Normal position length is 30 characters
 java.lang.String getPositionMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getPositionPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getPositionRange()
          Return the range specification for this field
 java.lang.String getPositionValidityCheck()
          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.
 SandQueryMessage getQueryMessage()
          Returns null
 SandInstanceMessage getRootMsg()
          Accessor for rootMsg
static SandInstanceMessage getRootMsgDefaultValue()
          Default value for rootMsg.
 java.lang.String getRootMsgFieldPrintValue()
          Return the print name of the rootMsg field.
static boolean getRootMsgFlag(int fieldflag)
          Field flag accessor.
static SandInstanceMessage getRootMsgInvalidValue()
          Invalid value for rootMsg.
 java.lang.String getRootMsgMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getRootMsgPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getRootMsgRange()
          Return the range specification for this field
 java.lang.String getRootMsgValidityCheck()
          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 UIFormInitializer instance
 SandUpdateMessage getUpdateMessage()
          Returns null
 UIFormQuery getUserQuery()
          Accessor for userQuery
static UIFormQuery getUserQueryDefaultValue()
          Default value for userQuery.
 java.lang.String getUserQueryFieldPrintValue()
          Return the print name of the userQuery field.
static boolean getUserQueryFlag(int fieldflag)
          Field flag accessor.
static UIFormQuery getUserQueryInvalidValue()
          Invalid value for userQuery.
 java.lang.String getUserQueryMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getUserQueryPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getUserQueryRange()
          Return the range specification for this field
 java.lang.String getUserQueryValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 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 insertFindKeys(int index, java.lang.String value)
          Insert the specified element at the specified index.
 void insertModeStack(int index, int value)
          Insert the specified element at the specified index.
 void insertOutputText(int index, ErrorInfo value)
          Insert the specified element at the specified index.
 void insertPosition(int index, java.lang.String 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 lastFindKeys()
          Returns the last element pushed onto the findKeys stack without changing the stack.
 int lastModeStack()
          Returns the last element pushed onto the modeStack stack without changing the stack.
 java.lang.String lastPosition()
          Returns the last element pushed onto the position stack without changing the stack.
static java.lang.String modeStackActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 boolean modeStackContains(int val)
          Returns true if modeStack contains the specified value.
 int modeStackIndexOf(int val)
          Return the index of the specified value in modeStack, or -1 if not found.
 int modeStackLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static int modeStackLabelToValueStatic(java.lang.String label)
           
static java.lang.String modeStackPrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String modeStackPrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String modeStackValueToLabel(int val)
          Given a value, return the declared label for it.
static java.lang.String modeStackValueToLabelStatic(int val)
           
 boolean outputTextContains(ErrorInfo val)
          Returns true if outputText contains the specified value.
 int outputTextIndexOf(ErrorInfo val)
          Return the index of the specified value in outputText, or -1 if not found.
 java.lang.String popFindKeys()
          Pops the last element off the findKeys stack.
 int popModeStack()
          Pops the last element off the modeStack stack.
 java.lang.String popPosition()
          Pops the last element off the position stack.
 boolean positionContains(java.lang.String val)
          Returns true if position contains the specified value.
 int positionIndexOf(java.lang.String val)
          Return the index of the specified value in position, or -1 if not found.
 void pushFindKeys(java.lang.String element)
          Pushes an element onto the findKeys stack.
 void pushModeStack