public class JUCtrlParameterDef extends JUCtrlAttrsDef implements AttributeDef, AttributeHints
PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationTypeAttributeHints.ControlType| Modifier and Type | Field and Description | 
|---|---|
| static int | PARAM_DEFAULTFor internal use only. | 
| static int | PARAM_FINALBinding definition has the expression to get to the value that should be used for this parameter. | 
| static int | PARAM_MANDATORYParameter value has to be set by the caller. | 
| static int | PARAM_OPTIONALBinding definition's value is used only if the parameter is not specifically set by the caller. | 
| static java.lang.String | PNAME_Option | 
| static java.lang.String | PNAME_Precision | 
| static java.lang.String | PNAME_PrecisionRule | 
| static java.lang.String | PNAME_ReadOnly | 
| static java.lang.String | PNAME_Scale | 
| static java.lang.String | PNAME_Type | 
| static java.lang.String | PNAME_Value | 
DEFAULT_HANDLER, PNAME_ApplyValidation, PNAME_AttrNames, PNAME_AttrViewExprs, PNAME_CtrlPermission, PNAME_IncludeSelectionAttr, PNAME_InputHandler, PNAME_ListNullValueId, PNAME_Permissions, PNAME_SelectionAttr, PNAME_SelectionValue, PNAME_UnSelectionValue, PNAME_UseRowHintsPNAME_ControlBindingClass, PNAME_ControlClass, PNAME_CustomInputHandler, PNAME_InitialValue, PNAME_IterBinding, PNAME_TYPE, PNAME_ViewableDEF_XMLNS, DEF_XMLNS_BASE, EMPTY_STR, PNAME_AccessorIterator, PNAME_Action, PNAME_Boolean, PNAME_Button, PNAME_ButtonGroup, PNAME_Calendar, PNAME_ComboBox, PNAME_ComboBoxLovEdit, PNAME_DataControlAction, PNAME_DefaultControl, PNAME_DynamicTable, PNAME_EnumList, PNAME_EventBinding, PNAME_EventEnabled, PNAME_EventEnabled_NONE, PNAME_EventEnabled_PPR, PNAME_EventEnabled_PUSH, PNAME_FormattedTextField, PNAME_Graph, PNAME_HGrid, PNAME_Iterator, PNAME_Label, PNAME_ListSingleSel, PNAME_LovButton, PNAME_LOVList, PNAME_MethodAction, PNAME_MethodIterator, PNAME_NavigationBar, PNAME_NavigationList, PNAME_Panel, PNAME_Parameter, PNAME_Permission, PNAME_ProgressBar, PNAME_ProgressBarAttr, PNAME_Range, PNAME_ScrollBar, PNAME_ScrollBarAttr, PNAME_Search, PNAME_Shuttle, PNAME_Slider, PNAME_SliderAttr, PNAME_Spinner, PNAME_Table, PNAME_TextField, PNAME_ToplinkIterator, PNAME_Tree, PNAME_TreeTablemEditedProperties, mEditedPropertyExprsDEF_MDS_CLIENT_KEY, DEF_SCOPE_ALL, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, DEF_SCOPE_SITE, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY, PROPERTY_EXPRMAPmFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIXATTR_ASSOCIATED_ROW, ATTR_ASSOCIATED_ROWITERATOR, ATTR_DYNAMIC, ATTR_ENTITY_DERIVED, ATTR_HIDDEN, ATTR_PERSISTENT, ATTR_ROWSET, ATTR_SQL_DERIVED, ATTR_TRANSIENT, ATTR_VARIABLE, READONLY, UPDATEABLE, UPDATEABLE_WHILE_NEWATTRIBUTE_AUTOSUBMIT, ATTRIBUTE_BINDEDITOR_LABEL, ATTRIBUTE_CTL_CATEGORY, ATTRIBUTE_CTL_DISPLAYHEIGHT, ATTRIBUTE_CTL_DISPLAYWIDTH, ATTRIBUTE_CTL_FIELD_ORDER, ATTRIBUTE_CTL_FORMTYPE, ATTRIBUTE_CTL_TYPE, ATTRIBUTE_DEFINITION_STATE, ATTRIBUTE_DISPLAY_HINT, ATTRIBUTE_DISPLAY_HINT_DISPLAY, ATTRIBUTE_DISPLAY_HINT_HIDE, ATTRIBUTE_FORM_TYPE_DETAIL, ATTRIBUTE_FORM_TYPE_SHORT, ATTRIBUTE_LABEL, ATTRIBUTE_LABEL_PLURAL, ATTRIBUTE_LOVNAME, ATTRIBUTE_PAYLOAD_HINT, ATTRIBUTE_PAYLOAD_HINT_HIDE, ATTRIBUTE_TIMEZONE_ID, ATTRIBUTE_TOOLTIP, CTL_CHECK_BOX, CTL_CHOICE_LIST, CTL_COMBO_BOX, CTL_COMBO_BOX_LOV, CTL_DATE, CTL_DEFAULT, CTL_DELIMITEDIDS_CHOICE, CTL_EDIT, CTL_IMAGE, CTL_INPUT_TEXT_LOV, CTL_LIST_BOX, CTL_NUMBER_EDIT, CTL_RADIO_GROUP, CTLTYPE_CHECKBOX, CTLTYPE_COMBO, CTLTYPE_COMBOLOV, CTLTYPE_DATE, CTLTYPE_DEFAULT, CTLTYPE_DELIMITEDIDS_CHOICE, CTLTYPE_EDIT, CTLTYPE_IMAGE, CTLTYPE_LIST, CTLTYPE_LISTBOX, CTLTYPE_LOV, CTLTYPE_NUMEDIT, CTLTYPE_RADIOGRP, CTLTYPE_TOGGLE, FMT_FORMAT, FMT_FORMATTER, HINT_NAME_AUTOSUBMIT, HINT_NAME_CATEGORY, HINT_NAME_CTL_TYPE, HINT_NAME_DESCRIPTION, HINT_NAME_DISPLAY_HEIGHT, HINT_NAME_DISPLAY_HINT, HINT_NAME_DISPLAY_WIDTH, HINT_NAME_FIELD_ORDER, HINT_NAME_FORMAT, HINT_NAME_LABEL, HINT_NAME_LABEL_PLURAL, HINT_NAME_LOVNAME, HINT_NAME_MANDATORY, HINT_NAME_MAX_LENGTH, HINT_NAME_MAX_VALUE, HINT_NAME_MIN_LENGTH, HINT_NAME_MIN_VALUE, HINT_NAME_PAYLOAD_HINT, HINT_NAME_SECRET, HINT_NAME_TIMEZONEID, HINT_NAME_TOOLTIP, HINT_NAME_UPDATEABLE, HINT_NAME_WATERMARK, PNAME_Button, PNAME_ButtonGroup, PNAME_ComboBox, PNAME_ComboBoxLovEdit, PNAME_ENSURE_KEY_ATTR, PNAME_EnumList, PNAME_LovButton, PNAME_ROWNUMATTR, PNAME_SOURCENAME_ACCESSOR, PNAME_SOURCENAME_ATTR, PNAME_TextFieldDEFINITION_STATE_ACTIVE, DEFINITION_STATE_DEPRECATED, PROPERTY_DEFINITION_STATE, PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIPXML_STATEMENT| Constructor and Description | 
|---|
| JUCtrlParameterDef() | 
| Modifier and Type | Method and Description | 
|---|---|
| protected DCControlBinding | createControlBindingInstance(java.lang.Object control,
                            DCBindingContainer formBnd) | 
| boolean | displayInShortForm(LocaleContext locale)Returns true if the attribute is to displayed in the short(summary) form. | 
| ViewObject | getAccessorVO(ViewObject originVO)For an accessor attribute, this method creates a View Object that
 works for the View Link definition. | 
| byte | getAttributeKind()*** For internal framework use only *** | 
| java.lang.String | getCategory(LocaleContext locale)Returns the category that this attribute belongs to. | 
| java.lang.String | getColumnName()For internal framework use only *** | 
| java.lang.String | getColumnNameForQuery()For internal framework use only *** | 
| java.lang.String[][] | getCompOpers(LocaleContext locale)Returns a Map of operators for this attribute. | 
| int | getControlType(LocaleContext locale)Returns the preferred control type for this attribute | 
| java.lang.String | getDefinitionState(LocaleContext locale)Retrives the definition state string that indicates if this object is deprecated. | 
| int | getDisplayHeight(LocaleContext locale)Returns the display width for this attribute | 
| java.lang.String | getDisplayHint(LocaleContext locale)Retrieves the displya hint that dictates whether this
  attributr should be visible or not. | 
| int | getDisplayWidth(LocaleContext locale)Returns the display width for this attribute | 
| int | getElemSQLType()Returns the jdbc type of the elements of this attribute. | 
| java.lang.Class | getElemType()Returns the element type of the attribute. | 
| java.lang.String | getExpression() | 
| double | getFieldOrder(LocaleContext locale)Returns the field order for this attribute. | 
| java.lang.String | getFormat(LocaleContext locale)returns the format string stored in the ui hints | 
| java.lang.String | getFormattedAttribute(AttributeList attrList,
                     LocaleContext locale)Returns the formatted value  for the attribute. | 
| Formatter | getFormatter(LocaleContext locale)returns the formatter object stored in the ui hints | 
| java.lang.String | getFormatterClassName(LocaleContext locale)returns the formatter class stored in the ui hints | 
| java.lang.String | getHint(LocaleContext locale,
       java.lang.String sHintName)Return defaulted hint value based on the hint name | 
| java.lang.String | getHintValue(LocaleContext locale,
            java.lang.String sHintName)Return hint value based on the hint name | 
| int | getIndex()Always return 0. | 
| java.lang.Class | getJavaType()Returns javatype of the value that bound
 expression returns. | 
| java.lang.String | getLabel(LocaleContext locale)Retrieves the label to be used in any attribute prompts | 
| java.lang.String | getLabelPlural(LocaleContext locale)Retrives the LabelPlural text to be used for this attribute | 
| ListBindingDef | getListBindingDef() | 
| java.lang.String | getLocaleName(LocaleContext locale,
             java.lang.String sName)function for retrieving the locale name of a hint | 
| java.lang.String | getLOVName()Gets the name of the LOV (list of values) associated with this
 attribute definition. | 
| java.util.Map | getOperators(LocaleContext locale) | 
| int | getOptionFlag() | 
| java.lang.String | getPayloadHint(LocaleContext locale)Retrieves the payload hint that dictates whether this
  attribute should be included in service payload or not. | 
| int | getPrecision()Return Precision value from metadata for this binding. | 
| int | getScale()Return Scale value from metadata for this binding. | 
| int | getSQLType()Always return -1. | 
| java.lang.String | getTooltip(LocaleContext locale)Retrives the tooltip text to be used for this attribute | 
| AttributeHints | getUIHelper()Returns this, as this object also implements AttributeHints interface | 
| byte | getUpdateableFlag()Tests if an attribute can be modified. | 
| boolean | hasFormatInformation(LocaleContext locale)Return true if any format  hints have been defined for this
   attribute. | 
| void | init(java.util.HashMap initValues) | 
| protected void | initSubType() | 
| boolean | isApplyPrecision() | 
| boolean | isAutoSubmit(LocaleContext locale)Returns autoSubmit value for this attribute. | 
| boolean | isDiscrColumn()Tests if an attribute is a discriminator. | 
| boolean | isFinal() | 
| boolean | isMandatory()Tests if an attribute does not allow null values. | 
| boolean | isOptional() | 
| boolean | isPrimaryKey()Always return false | 
| boolean | isQueriable()This binding is not queriable. | 
| boolean | isReadOnly()Return Updateable flag from metadata for this binding. | 
| boolean | isSelected()This binding is not queriable. | 
| java.lang.Object | parseFormattedAttribute(java.lang.String sValue,
                       LocaleContext locale)Strips off the formatting from a string and constructs an
   instance of the attribute's domain using the 'clean' string as
   a parameter of the contructor. | 
| protected void | retrieveFromXML(DefElement xmlElement,
               java.util.HashMap valueTab) | 
initializeControlBindingaddValidator, getAttrNames, getAttrViewExpressions, getChangeEventPolicy, getCustomInputHandler, getEventDefList, getFirstAttrName, getIterBinding, getJUCtrlInputHandler, getMessageBundleClass, getNullValueId, getNullValueObject, getResourceBundleDef, getSelectionDef, getValidators, hasCustomInputHandler, initSelectionDef, isApplyValidation, isPushDataChangeEvents, isPushOrPollDataChangeEvents, isUseRowHints, loadChildrenFromXML, loadCustomDef, loadEventDefinitions, loadFromXML, setApplyValidation, setAttributeNames, setCustomInputHandler, setEventDefList, setNullValueObject, setSelectionDef, setUseRowHintscreateControl, createControlBinding, createControlBinding, findControlBinding, getBindingContainerDef, getControlBindingClassName, getControlClassName, getDefTypeId, getDesignTimeClass, getInitialValue, getIterBinding, getIterBindingName, getLayoutCons, getViewableExpr, getXMLElementTag, setBindingContainerDef, setControlBindingClassName, setControlClassName, setInitialValue, setIterBindingNameconvertToBoolean, convertToDataChangePolicy, convertToInt, convertToIntArray, convertToLong, createAndLoadFromXML, getDefClassName, getDefXMLNameSpace, getOrigObject, getPermissionDef, getPersonalizer, getPersonalizerClass, getSubType, isDirty, isNew, loadPermissionDef, loadXMLContents, readXMLBoolean, readXMLInt, readXMLLong, readXMLString, readXMLStringArray, readXMLStringArrayList, readXMLStringArrayList, setDefClassName, setDirty, setNew, setOrigObject, setPermissionDef, setSubTypeaddDefImport, addExtendedDefObject, adjustPropertyMapForWrite, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffChildren, applyDiffContents, checkEditable, checkStructWithOld, close, createFromXML, deregisterSessionObject, diffChildren, diffContents, diffObjects, ensureDifferDetails, findDefImport, finishedLoading, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefWriter, getDefXMLElementTag, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getMajorVersion, getMinorVersion, getPropertyMap, getSubstitutedNames, getSyncLock, guaranteePath, hasExtendedDefObjects, isCustomizationEnabled, isCustomizationEnabled, isEditable, isFromTip, isLoadBase, isMajorVersionChanged, isMinorVersionChanged, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, loadDefImports, mergeChanges, mergePropertyMap, objectRemoved, reapplyChanges, registerClass, registerDefObject, registerSessionDefObject, registerSiteDefObject, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setEditable, setEditableFlag, setEditableObject, setFullName, setFullNameInternal, setLoadBase, setMajorVersionChanged, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, setupDefWriterFromMO, staticUpdateChildrenList, updateChildrenList, verifyVersion, verifyVersionNullCheck, writeChildren, writeContents, writeObject, writeVersion, writeXMLContentsaddPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getBaseDefObject, getContainerDef, getContainerName, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isDeprecated, isDynamicDefinitionObject, isObjectResolved, isSuppressUpdateCheck, loadCustomProperties, loadProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, resolveReferences, setBaseDefObject, setBaseDefObject, setDefScope, setMdsKey, setMdsReference, setName, setObjectResolved, setParent, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheckgetAllProperties, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, resolvePropertyRaw, setPropertiesMap, setPropertiesMap2, setPropertyclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetNamegetProperties, getProperty, getProperty, refreshPropertygetFullName, getNamegetFullNamegetFullName, getNamepublic static int PARAM_FINAL
public static int PARAM_OPTIONAL
public static int PARAM_MANDATORY
public static int PARAM_DEFAULT
public static final java.lang.String PNAME_Value
public static final java.lang.String PNAME_Type
public static final java.lang.String PNAME_Scale
public static final java.lang.String PNAME_Precision
public static final java.lang.String PNAME_Option
public static final java.lang.String PNAME_ReadOnly
public static final java.lang.String PNAME_PrecisionRule
protected void initSubType()
initSubType in class JUCtrlAttrsDefprotected DCControlBinding createControlBindingInstance(java.lang.Object control, DCBindingContainer formBnd)
createControlBindingInstance in class JUCtrlAttrsDefpublic final byte getAttributeKind()
getAttributeKind in interface AttributeDefATTR constants defined for this class.public final java.lang.String getColumnName()
getColumnName in interface AttributeDefpublic final java.lang.String getExpression()
public final java.lang.String getColumnNameForQuery()
getColumnNameForQuery in interface AttributeDefpublic final int getIndex()
getIndex in interface AttributeDefpublic final java.lang.Class getJavaType()
getJavaType in interface AttributeDefpublic final int getSQLType()
getSQLType in interface AttributeDefTypespublic final int getScale()
getScale in interface AttributeDefpublic final int getPrecision()
getPrecision in interface AttributeDefpublic final boolean isDiscrColumn()
AttributeDefisDiscrColumn in interface AttributeDefpublic final boolean isSelected()
isSelected in interface AttributeDefpublic final boolean isQueriable()
isQueriable in interface AttributeDeftrue if this attribute is queriable.public final boolean isReadOnly()
public final byte getUpdateableFlag()
AttributeDefgetUpdateableFlag in interface AttributeDefREADONLY, UPDATEABLE, or UPDATEABLE_WHILE_NEW.public final boolean isPrimaryKey()
isPrimaryKey in interface AttributeDeftrue if this is either a Primary Key attribute or
 part of the attributes that constitute the Primary Key for a given row.public final boolean isApplyPrecision()
public final boolean isMandatory()
AttributeDefisMandatory in interface AttributeDeftrue if this attribute cannot store a null valuepublic final boolean isOptional()
public final boolean isFinal()
public int getOptionFlag()
public final AttributeHints getUIHelper()
getUIHelper in interface AttributeDefAttributeHintspublic final java.lang.Class getElemType()
AttributeDefFor VARRAYs, this method returns the class name of the elements that are in the VARRAY.
Element type is relevant only if the attribute is an array attribute.
getElemType in interface AttributeDefpublic final int getElemSQLType()
AttributeDefFor VARRAYs, this method returns the jdbc type of the elements that are in the VARRAY.
Element type is relevant only if the attribute is an array attribute.
getElemSQLType in interface AttributeDefpublic ViewObject getAccessorVO(ViewObject originVO)
AttributeDefgetAccessorVO in interface AttributeDeforiginVO - the View Object that owns the accessorViewObject instance.public final java.lang.String getLabel(LocaleContext locale)
GenericHintsgetLabel in interface GenericHintspublic java.util.Map getOperators(LocaleContext locale)
public final java.lang.String getTooltip(LocaleContext locale)
GenericHintsgetTooltip in interface GenericHintspublic final java.lang.String getLabelPlural(LocaleContext locale)
GenericHintsgetLabelPlural in interface GenericHintspublic java.lang.String getDefinitionState(LocaleContext locale)
DefinitionObjectgetDefinitionState in interface GenericHintsgetDefinitionState in class DefinitionObjectpublic final java.lang.String getDisplayHint(LocaleContext locale)
AttributeHintsgetDisplayHint in interface AttributeHintspublic final java.lang.String getPayloadHint(LocaleContext locale)
AttributeHintsgetPayloadHint in interface AttributeHintspublic final int getControlType(LocaleContext locale)
AttributeHintsgetControlType in interface AttributeHintspublic final int getDisplayWidth(LocaleContext locale)
AttributeHintsgetDisplayWidth in interface AttributeHintspublic final int getDisplayHeight(LocaleContext locale)
AttributeHintsgetDisplayHeight in interface AttributeHintspublic final boolean isAutoSubmit(LocaleContext locale)
AttributeHintsisAutoSubmit in interface AttributeHintspublic final double getFieldOrder(LocaleContext locale)
AttributeHintsgetFieldOrder in interface AttributeHintspublic final java.lang.String getCategory(LocaleContext locale)
AttributeHintsgetCategory in interface AttributeHintspublic final java.lang.String getHint(LocaleContext locale, java.lang.String sHintName)
AttributeHintsgetHint in interface AttributeHintspublic final java.lang.String getHintValue(LocaleContext locale, java.lang.String sHintName)
GenericHintsgetHintValue in interface GenericHintspublic final java.lang.String getFormat(LocaleContext locale)
AttributeHintsgetFormat in interface AttributeHintspublic final java.lang.String getFormatterClassName(LocaleContext locale)
AttributeHintsgetFormatterClassName in interface AttributeHintspublic final Formatter getFormatter(LocaleContext locale)
AttributeHintsgetFormatter in interface AttributeHintspublic final boolean hasFormatInformation(LocaleContext locale)
AttributeHintshasFormatInformation in interface AttributeHintspublic final java.lang.String getFormattedAttribute(AttributeList attrList, LocaleContext locale)
AttributeHintsgetFormattedAttribute in interface AttributeHintspublic final java.lang.Object parseFormattedAttribute(java.lang.String sValue,
                                       LocaleContext locale)
AttributeHintsparseFormattedAttribute in interface AttributeHintspublic final boolean displayInShortForm(LocaleContext locale)
AttributeHintsdisplayInShortForm in interface AttributeHintspublic final java.lang.String getLocaleName(LocaleContext locale, java.lang.String sName)
AttributeHintsgetLocaleName in interface AttributeHintspublic java.lang.String[][] getCompOpers(LocaleContext locale)
AttributeHintsgetCompOpers in interface AttributeHintsprotected void retrieveFromXML(DefElement xmlElement, java.util.HashMap valueTab)
retrieveFromXML in class DCControlBindingDefpublic void init(java.util.HashMap initValues)
init in class JUCtrlValueDefpublic java.lang.String getLOVName()
AttributeDefgetLOVName in interface AttributeDefgetLOVName in interface AttributeHintspublic ListBindingDef getListBindingDef()
getListBindingDef in interface AttributeDef