Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1)

E10653-04

oracle.adf.model.binding
Class DCParameterDef

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.mom.DefinitionObject
          extended by oracle.jbo.mom.PersistableDefObject
              extended by oracle.adf.model.binding.DCDefBase
                  extended by oracle.adf.model.binding.DCControlBindingDef
                      extended by oracle.adf.model.binding.DCParameterDef
All Implemented Interfaces:
DefPersistable, PersistentDefinition

public class DCParameterDef
extends DCControlBindingDef


Field Summary
static int PARAM_DEFAULT
          For internal use only.
static int PARAM_FINAL
          Binding definition has the expression to get to the value that should be used for this parameter.
static java.lang.String PARAM_FINAL_STR
           
static int PARAM_MANDATORY
          Parameter value has to be set by the caller.
static java.lang.String PARAM_MANDATORY_STR
           
static int PARAM_OPTIONAL
          Binding definition's value is used only if the parameter is not specifically set by the caller.
static java.lang.String PARAM_OPTIONAL_STR
           
static java.lang.String PNAME_Evaluate
           
static java.lang.String PNAME_Evaluate_EveryTime
           
static java.lang.String PNAME_Evaluate_InPrepare
           
static java.lang.String PNAME_Evaluate_OnFirstUse
           
static java.lang.String PNAME_Lazy
           
static java.lang.String PNAME_Option
           
static java.lang.String PNAME_ReadOnly
           
static java.lang.String PNAME_Value
           
 
Fields inherited from class oracle.adf.model.binding.DCControlBindingDef
PNAME_ControlBindingClass, PNAME_ControlClass, PNAME_CustomInputHandler, PNAME_InitialValue, PNAME_IterBinding, PNAME_TYPE, PNAME_Viewable
 
Fields inherited from class oracle.adf.model.binding.DCDefBase
DEF_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_Shuttle, PNAME_Slider, PNAME_SliderAttr, PNAME_Spinner, PNAME_Table, PNAME_TextField, PNAME_ToplinkIterator, PNAME_Tree, PNAME_TreeTable
 
Fields inherited from class oracle.jbo.mom.DefinitionObject
DEF_MDS_CLIENT_KEY, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY
 
Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX
 
Fields inherited from interface oracle.jbo.mom.xml.DefPersistable
XML_STATEMENT
 
Constructor Summary
DCParameterDef()
           
 
Method Summary
static int convertParameterOptionStr(java.lang.String str)
           
protected  DCControlBinding createControlBindingInstance(java.lang.Object control, DCBindingContainer formBnd)
           
 DCParameter.EvalType getEvaluationType()
           
 java.lang.String getExpression()
           
 int getOptionFlag()
           
 void init(java.util.HashMap initValues)
          For internal use only.
protected  void initializeControlBinding(DCBindingContainer formBnd, DCControlBinding controlBnd)
           
protected  void initSubType()
           
 boolean isFinal()
          A usage cannot override this parameter expression.
 boolean isLazy()
          May be used to skip parameter evaluation during refresh.
 boolean isMandatory()
          Return true if a value for this parameter has to be passed in in the usage of this parameter's container.
 boolean isOptional()
           
 boolean isReadOnly()
          Return false if this parameter's expression is allowed to be updateable at runtime via setExpression
protected  void retrieveFromXML(DefElement xmlElement, java.util.HashMap valueTab)
           
 void setExpression(java.lang.String value)
           
 
Methods inherited from class oracle.adf.model.binding.DCControlBindingDef
createControl, createControlBinding, createControlBinding, findControlBinding, getBindingContainerDef, getControlBindingClassName, getControlClassName, getDefTypeId, getDesignTimeClass, getInitialValue, getIterBinding, getIterBindingName, getLayoutCons, getViewableExpr, getXMLElementTag, loadChildrenFromXML, loadCustomDef, setBindingContainerDef, setControlBindingClassName, setControlClassName, setInitialValue, setIterBindingName
 
Methods inherited from class oracle.adf.model.binding.DCDefBase
convertToBoolean, convertToDataChangePolicy, convertToInt, convertToIntArray, convertToLong, createAndLoadFromXML, getDefClassName, getDefXMLNameSpace, getOrigObject, getPermissionDef, getPersonalizer, getPersonalizerClass, getSubType, isDirty, isNew, loadFromXML, loadPermissionDef, loadXMLContents, readXMLBoolean, readXMLInt, readXMLLong, readXMLString, readXMLStringArray, readXMLStringArrayList, readXMLStringArrayList, setDefClassName, setDirty, setNew, setOrigObject, setPermissionDef, setSubType
 
Methods inherited from class oracle.jbo.mom.PersistableDefObject
addDefImport, allocatePropertyMap, checkEditable, close, createFromXML, deregisterSessionObject, findDefImport, finishedLoading, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefWriter, getDefXMLElementTag, getEditObject, getFileName, getFullDirName, getFullFileName, getPropertyMap, getSubstitutedNames, guaranteePath, isEditable, loadDefImports, objectRemoved, registerClass, registerDefObject, registerSessionDefObject, remove, removeAndDelete, removeDefImport, removeProperty, saveXMLContents, setDefaultBaseDir, setDefMgr, setEditable, setProperty, setPropertyMap, updateChildrenList, verifyVersion, writeChildren, writeContents, writeObject, writeVersion, writeXMLContents
 
Methods inherited from class oracle.jbo.mom.DefinitionObject
addExtendedDefObject, addPropertySetName, getBaseDefObject, getContainerDef, getContainerName, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, hasExtendedDefObjects, isBaseDefFor, isDynamicDefinitionObject, isObjectResolved, loadCustomProperties, loadProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, removeExtendedDefObject, resolveReferences, setBaseDefObject, setBaseDefObject, setDefScope, setMdsKey, setMdsReference, setName, setObjectResolved, setParent, setPropertySetName
 
Methods inherited from class oracle.jbo.common.NamedObjectImpl
getAllProperties, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getResourcesFromBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, resolvePropertyRaw, setFullName, setPropertiesMap, setPropertiesMap2, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.mom.xml.DefPersistable
getFullName
 

Field Detail

PNAME_Value

public static final java.lang.String PNAME_Value
See Also:
Constant Field Values

PNAME_Option

public static final java.lang.String PNAME_Option
See Also:
Constant Field Values

PNAME_ReadOnly

public static final java.lang.String PNAME_ReadOnly
See Also:
Constant Field Values

PNAME_Lazy

public static final java.lang.String PNAME_Lazy
See Also:
Constant Field Values

PNAME_Evaluate

public static final java.lang.String PNAME_Evaluate
See Also:
Constant Field Values

PNAME_Evaluate_InPrepare

public static final java.lang.String PNAME_Evaluate_InPrepare
See Also:
Constant Field Values

PNAME_Evaluate_OnFirstUse

public static final java.lang.String PNAME_Evaluate_OnFirstUse
See Also:
Constant Field Values

PNAME_Evaluate_EveryTime

public static final java.lang.String PNAME_Evaluate_EveryTime
See Also:
Constant Field Values

PARAM_FINAL

public static final int PARAM_FINAL
Binding definition has the expression to get to the value that should be used for this parameter.

See Also:
Constant Field Values

PARAM_OPTIONAL

public static final int PARAM_OPTIONAL
Binding definition's value is used only if the parameter is not specifically set by the caller. This is the default.

See Also:
Constant Field Values

PARAM_MANDATORY

public static final int PARAM_MANDATORY
Parameter value has to be set by the caller.

See Also:
Constant Field Values

PARAM_DEFAULT

public static final int PARAM_DEFAULT
For internal use only.

See Also:
Constant Field Values

PARAM_OPTIONAL_STR

public static final java.lang.String PARAM_OPTIONAL_STR
See Also:
Constant Field Values

PARAM_FINAL_STR

public static final java.lang.String PARAM_FINAL_STR
See Also:
Constant Field Values

PARAM_MANDATORY_STR

public static final java.lang.String PARAM_MANDATORY_STR
See Also:
Constant Field Values
Constructor Detail

DCParameterDef

public DCParameterDef()
Method Detail

initSubType

protected void initSubType()
Overrides:
initSubType in class DCDefBase

createControlBindingInstance

protected DCControlBinding createControlBindingInstance(java.lang.Object control,
                                                        DCBindingContainer formBnd)
Specified by:
createControlBindingInstance in class DCControlBindingDef

initializeControlBinding

protected void initializeControlBinding(DCBindingContainer formBnd,
                                        DCControlBinding controlBnd)
Overrides:
initializeControlBinding in class DCControlBindingDef

getExpression

public final java.lang.String getExpression()

setExpression

public final void setExpression(java.lang.String value)

isReadOnly

public final boolean isReadOnly()
Return false if this parameter's expression is allowed to be updateable at runtime via setExpression


isMandatory

public final boolean isMandatory()
Return true if a value for this parameter has to be passed in in the usage of this parameter's container.


isOptional

public final boolean isOptional()

isFinal

public final boolean isFinal()
A usage cannot override this parameter expression.


getOptionFlag

public int getOptionFlag()

isLazy

public final boolean isLazy()
May be used to skip parameter evaluation during refresh.


getEvaluationType

public final DCParameter.EvalType getEvaluationType()

retrieveFromXML

protected void retrieveFromXML(DefElement xmlElement,
                               java.util.HashMap valueTab)
Overrides:
retrieveFromXML in class DCControlBindingDef

init

public void init(java.util.HashMap initValues)
For internal use only.

Overrides:
init in class DCControlBindingDef

convertParameterOptionStr

public static int convertParameterOptionStr(java.lang.String str)

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1)

E10653-04

Copyright © 1997, 2010, Oracle. All rights reserved.