org.sandev.ui.sandmessages
Class Link

java.lang.Object
  org.sandev.ui.structs.LinkStruct
      org.sandev.ui.sandmessages.Link

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 Link
extends LinkStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

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

Field Summary

static int	LINKTYPE_EMPTY Possible value for linkType
static int	LINKTYPE_FORM Possible value for linkType
static int	LINKTYPE_TEXT Possible value for linkType
static int	MODE_PRODUCTION Possible value for mode
static int	MODE_WIREFRAME Possible value for mode

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

actions, currentTabDisplayName, formState, linkType, mode, name, tabs, target, template, title, wireframeText

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

Link()
Default constructor calls init.

Method Summary

boolean	actionsContains(Action val) Returns true if actions contains the specified value.
int	actionsIndexOf(Action val) Return the index of the specified value in actions, or -1 if not found.
void	addActions(Action element) Appends a value to actions
void	addActions(Action[] elements) Appends an array of values to actions
void	addTabs(Action element) Appends a value to tabs
void	addTabs(Action[] elements) Appends an array of values to tabs
void	clearActions() Clears all values from actions
void	clearTabs() Clears all values from tabs
Link	cloneLink() Make a deep copy of this Link.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneLink
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(Link 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.
Action[]	getActions() Accessor for actions.
Action	getActions(int index) Returns the element at the specified index.
static Action[]	getActionsDefaultValue() Default value for actions.
static Action	getActionsElementInvalidValue() Invalid value for actionselement.
java.lang.String	getActionsFieldPrintValue() Return the print name of the actions field.
static boolean	getActionsFlag(int fieldflag) Field flag accessor.
static Action[]	getActionsInvalidValue() Invalid value for actions.
java.lang.String	getActionsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getActionsPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getActionsRange() Return the range specification for this field
java.lang.String	getActionsValidityCheck() 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.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
java.lang.String	getCurrentTabDisplayName() Accessor for currentTabDisplayName
static java.lang.String	getCurrentTabDisplayNameDefaultValue() Default value for currentTabDisplayName.
java.lang.String	getCurrentTabDisplayNameFieldPrintValue() Return the print name of the currentTabDisplayName field.
static boolean	getCurrentTabDisplayNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getCurrentTabDisplayNameInvalidValue() Invalid value for currentTabDisplayName.
static int	getCurrentTabDisplayNameLengthMax() Maximum currentTabDisplayName length is 70 characters
static int	getCurrentTabDisplayNameLengthNorm() Normal currentTabDisplayName length is 30 characters
java.lang.String	getCurrentTabDisplayNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getCurrentTabDisplayNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getCurrentTabDisplayNameRange() Return the range specification for this field
java.lang.String	getCurrentTabDisplayNameValidityCheck() 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(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.sandmessages.UIFormInitializer	getFormState() Accessor for formState
static org.sandev.basics.sandmessages.UIFormInitializer	getFormStateDefaultValue() Default value for formState.
java.lang.String	getFormStateFieldPrintValue() Return the print name of the formState field.
static boolean	getFormStateFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.UIFormInitializer	getFormStateInvalidValue() Invalid value for formState.
java.lang.String	getFormStateMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getFormStatePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getFormStateRange() Return the range specification for this field
java.lang.String	getFormStateValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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.
int	getLinkType() Accessor for linkType
static java.lang.String[]	getLinkTypeActualVals() Return an array of the possible values for this field as Strings.
static int	getLinkTypeDefaultValue() Default value for linkType.
static java.lang.String	getLinkTypeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getLinkTypeFieldPrintValue() Return the print name of the linkType field.
static boolean	getLinkTypeFlag(int fieldflag) Field flag accessor.
static int	getLinkTypeInvalidValue() Invalid value for linkType.
static java.lang.String[]	getLinkTypeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getLinkTypeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getLinkTypePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getLinkTypePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLinkTypeRange() Return the range specification for this field
java.lang.String	getLinkTypeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getMode() Accessor for mode
static java.lang.String[]	getModeActualVals() Return an array of the possible values for this field as Strings.
static int	getModeDefaultValue() Default value for mode.
static java.lang.String	getModeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getModeFieldPrintValue() Return the print name of the mode field.
static boolean	getModeFlag(int fieldflag) Field flag accessor.
static int	getModeInvalidValue() Invalid value for mode.
static java.lang.String[]	getModeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getModeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getModePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getModePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getModeRange() Return the range specification for this field
java.lang.String	getModeValidityCheck() 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.
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 null
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new Link instance
Action[]	getTabs() Accessor for tabs.
Action	getTabs(int index) Returns the element at the specified index.
static Action[]	getTabsDefaultValue() Default value for tabs.
static Action	getTabsElementInvalidValue() Invalid value for tabselement.
java.lang.String	getTabsFieldPrintValue() Return the print name of the tabs field.
static boolean	getTabsFlag(int fieldflag) Field flag accessor.
static Action[]	getTabsInvalidValue() Invalid value for tabs.
java.lang.String	getTabsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTabsPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTabsRange() Return the range specification for this field
java.lang.String	getTabsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getTarget() Accessor for target
static java.lang.String	getTargetDefaultValue() Default value for target.
java.lang.String	getTargetFieldPrintValue() Return the print name of the target field.
static boolean	getTargetFlag(int fieldflag) Field flag accessor.
static java.lang.String	getTargetInvalidValue() Invalid value for target.
static int	getTargetLengthMax() Maximum target length is 70 characters
static int	getTargetLengthNorm() Normal target length is 30 characters
java.lang.String	getTargetMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTargetPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTargetRange() Return the range specification for this field
java.lang.String	getTargetValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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 70 characters
static int	getTemplateLengthNorm() Normal template length is 30 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.
java.lang.String	getTitle() Accessor for title
static java.lang.String	getTitleDefaultValue() Default value for title.
java.lang.String	getTitleFieldPrintValue() Return the print name of the title field.
static boolean	getTitleFlag(int fieldflag) Field flag accessor.
static java.lang.String	getTitleInvalidValue() Invalid value for title.
static int	getTitleLengthMax() Maximum title length is 70 characters
static int	getTitleLengthNorm() Normal title length is 30 characters
java.lang.String	getTitleMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTitlePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTitleRange() Return the range specification for this field
java.lang.String	getTitleValidityCheck() 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 LinkUpdate instance
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
java.lang.String	getWireframeText() Accessor for wireframeText
static java.lang.String	getWireframeTextDefaultValue() Default value for wireframeText.
java.lang.String	getWireframeTextFieldPrintValue() Return the print name of the wireframeText field.
static boolean	getWireframeTextFlag(int fieldflag) Field flag accessor.
static java.lang.String	getWireframeTextInvalidValue() Invalid value for wireframeText.
static int	getWireframeTextLengthMax() Maximum wireframeText length is 16384 characters
static int	getWireframeTextLengthNorm() Normal wireframeText length is 512 characters
java.lang.String	getWireframeTextMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getWireframeTextPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getWireframeTextRange() Return the range specification for this field
java.lang.String	getWireframeTextValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
void	init() Initialize all fields to their default values
void	insertActions(int index, Action value) Insert the specified element at the specified index.
void	insertTabs(int index, Action 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.
static java.lang.String	linkTypeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	linkTypeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	linkTypeLabelToValueStatic(java.lang.String label)
static java.lang.String	linkTypePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	linkTypePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	linkTypeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	linkTypeValueToLabelStatic(int val)
static java.lang.String	modeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	modeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	modeLabelToValueStatic(java.lang.String label)
static java.lang.String	modePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	modePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	modeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	modeValueToLabelStatic(int val)
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.
Action	removeActions(int index) Remove the element at the specified index and return it.
boolean	removeActionsValue(Action value) Removes the given element from actions.
Action	removeTabs(int index) Remove the element at the specified index and return it.
boolean	removeTabsValue(Action value) Removes the given element from tabs.
Screen	resolveTargetReference(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Screen	resolveTargetReferenceNonCrit(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance with all default values instead.
void	setActions(Action[] actions) Mutator for actions
void	setActions(int index, Action value) Set the value at the index specified.
void	setActions(java.lang.Object[] actions) Generic mutator for actions
void	setCurrentTabDisplayName(java.lang.Object currentTabDisplayName) Generic mutator for currentTabDisplayName
void	setCurrentTabDisplayName(java.lang.String currentTabDisplayName) Mutator for currentTabDisplayName
void	setFormState(java.lang.Object formState) Generic mutator for formState
void	setFormState(org.sandev.basics.sandmessages.UIFormInitializer formState) Mutator for formState
void	setLinkType(int linkType) Mutator for linkType
void	setMode(int mode) Mutator for mode
void	setName(java.lang.Object name) Generic mutator for name
void	setName(java.lang.String name) Mutator for name
void	setTabs(Action[] tabs) Mutator for tabs
void	setTabs(int index, Action value) Set the value at the index specified.
void	setTabs(java.lang.Object[] tabs) Generic mutator for tabs
void	setTarget(java.lang.Object target) Generic mutator for target
void	setTarget(java.lang.String target) Mutator for target
void	setTemplate(java.lang.Object template) Generic mutator for template
void	setTemplate(java.lang.String template) Mutator for template
void	setTitle(java.lang.Object title) Generic mutator for title
void	setTitle(java.lang.String title) Mutator for title
void	setWireframeText(java.lang.Object wireframeText) Generic mutator for wireframeText
void	setWireframeText(java.lang.String wireframeText) Mutator for wireframeText
Link	shallowCopy() Make a shallow copy of this Link.
int	sizeofActions() Returns the size of actions.
int	sizeofTabs() Returns the size of tabs.
boolean	tabsContains(Action val) Returns true if tabs contains the specified value.
int	tabsIndexOf(Action val) Return the index of the specified value in tabs, or -1 if not found.
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

LINKTYPE_TEXT

public static final int LINKTYPE_TEXT

Possible value for linkType

See Also:

Constant Field Values

LINKTYPE_FORM

public static final int LINKTYPE_FORM

Possible value for linkType

See Also:

Constant Field Values

LINKTYPE_EMPTY

public static final int LINKTYPE_EMPTY

Possible value for linkType

See Also:

Constant Field Values

MODE_PRODUCTION

public static final int MODE_PRODUCTION

Possible value for mode

See Also:

Constant Field Values

MODE_WIREFRAME

public static final int MODE_WIREFRAME

Possible value for mode

See Also:

Constant Field Values

Constructor Detail

Link

public Link()

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

getLinkType

public int getLinkType()

Accessor for linkType

setLinkType

public void setLinkType(int linkType)

Mutator for linkType

linkTypeValueToLabel

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

linkTypeValueToLabelStatic

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

linkTypeLabelToValue

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

linkTypeLabelToValueStatic

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

getLinkTypePrintVals

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

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.

getLinkTypeKeyVals

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

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.

getLinkTypeActualVals

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

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

linkTypePrint2Key

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

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

linkTypePrint2Actual

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

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

linkTypeActual2Print

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

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

getLinkTypeEnumSummary

public static java.lang.String getLinkTypeEnumSummary()

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

getLinkTypeFlag

public static boolean getLinkTypeFlag(int fieldflag)

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

getLinkTypeDefaultValue

public static int getLinkTypeDefaultValue()

Default value for linkType. Returns LINKTYPE_TEXT

getLinkTypeInvalidValue

public static int getLinkTypeInvalidValue()

Invalid value for linkType. Returns 0

getLinkTypePrintValue

public java.lang.String getLinkTypePrintValue()

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.

getLinkTypeFieldPrintValue

public java.lang.String getLinkTypeFieldPrintValue()

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

getLinkTypeRange

public java.lang.String getLinkTypeRange()

Return the range specification for this field

getLinkTypeValidityCheck

public java.lang.String getLinkTypeValidityCheck()

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.

getLinkTypeMetatype

public java.lang.String getLinkTypeMetatype()

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

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.

getTitle

public java.lang.String getTitle()

Accessor for title

setTitle

public void setTitle(java.lang.String title)

Mutator for title

setTitle

public void setTitle(java.lang.Object title)

Generic mutator for title

getTitleFlag

public static boolean getTitleFlag(int fieldflag)

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

getTitleLengthNorm

public static int getTitleLengthNorm()

Normal title length is 30 characters

getTitleLengthMax

public static int getTitleLengthMax()

Maximum title length is 70 characters

getTitleDefaultValue

public static java.lang.String getTitleDefaultValue()

Default value for title. Returns ""

getTitleInvalidValue

public static java.lang.String getTitleInvalidValue()

Invalid value for title. Returns null

getTitlePrintValue

public java.lang.String getTitlePrintValue()

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.

getTitleFieldPrintValue

public java.lang.String getTitleFieldPrintValue()

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

getTitleRange

public java.lang.String getTitleRange()

Return the range specification for this field

getTitleValidityCheck

public java.lang.String getTitleValidityCheck()

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.

getTitleMetatype

public java.lang.String getTitleMetatype()

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

getTarget

public java.lang.String getTarget()

Accessor for target

setTarget

public void setTarget(java.lang.String target)

Mutator for target

setTarget

public void setTarget(java.lang.Object target)

Generic mutator for target

getTargetFlag

public static boolean getTargetFlag(int fieldflag)

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

getTargetLengthNorm

public static int getTargetLengthNorm()

Normal target length is 30 characters

getTargetLengthMax

public static int getTargetLengthMax()

Maximum target length is 70 characters

getTargetDefaultValue

public static java.lang.String getTargetDefaultValue()

Default value for target. Returns ""

getTargetInvalidValue

public static java.lang.String getTargetInvalidValue()

Invalid value for target. Returns null

getTargetPrintValue

public java.lang.String getTargetPrintValue()

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.

getTargetFieldPrintValue

public java.lang.String getTargetFieldPrintValue()

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

getTargetRange

public java.lang.String getTargetRange()

Return the range specification for this field

resolveTargetReferenceNonCrit

public Screen resolveTargetReferenceNonCrit(org.sandev.basics.util.NameLookup lookup,
                                            org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning a new instance with all default values instead. This is to support the UI, which is calling to get detail for a richer display. If the detail is not available, it's not critical.

resolveTargetReference

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

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getTargetValidityCheck

public java.lang.String getTargetValidityCheck()

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.

getTargetMetatype

public java.lang.String getTargetMetatype()

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