Skip navigation links

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

E52932-01


oracle.jbo.server
Class BoundParameter

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.common.VariableImpl
          extended by oracle.jbo.server.BoundParameter

All Implemented Interfaces:
java.io.Serializable, AttributeDef, AttributeHints, ResourceBundleOwner, JIReservedVarNames, ExprWrappable, GenericHints, JboReservedVarNames, DiffMergeable, DefPersistable, PersistentDefinition, Properties, ValidationManager, Variable
Direct Known Subclasses:
AttrFinderParameter, ExprFinderParameter

public class BoundParameter
extends VariableImpl
See Also:
Serialized Form

Nested Class Summary

 

Nested classes/interfaces inherited from interface oracle.jbo.AttributeHints
AttributeHints.ControlType

 

Field Summary
protected static java.lang.String[] BPARAM_DIFF_STRING_ELEMS
           
static java.lang.String PARAM_OPTIONAL
           
static java.lang.String PARAM_REQUIRED
           
static java.lang.String PARAM_SELECTIVELY_REQUIRED
           

 

Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX

 

Fields inherited from interface oracle.jbo.Variable
VAR_KIND_VIEW_CRITERIA_PARAM, VAR_KIND_WHERE_CLAUSE_PARAM, VAR_KIND_WHERE_OR_CRIT_PARAM

 

Fields inherited from interface oracle.jbo.AttributeDef
ATTR_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_NEW

 

Fields inherited from interface oracle.jbo.AttributeHints
ATTRIBUTE_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_PAYLOAD_HINT_SHOW, ATTRIBUTE_REQUIRED_HINT, ATTRIBUTE_REQUIRED_HINT_OPTIONAL, ATTRIBUTE_REQUIRED_HINT_REQUIRED, ATTRIBUTE_REQUIRED_HINT_SELECTIVELY_REQUIRED, 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_DYNAMIC_LOV_SUPPORT, PNAME_EnumList, PNAME_LovButton, PNAME_TextField

 

Fields inherited from interface oracle.jbo.GenericHints
DEFINITION_STATE_ACTIVE, DEFINITION_STATE_DEPRECATED, PROPERTY_DEFINITION_STATE, PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP

 

Fields inherited from interface oracle.jbo.JboReservedVarNames
RESERVED_VAR_AGG_AVG, RESERVED_VAR_AGG_COUNT, RESERVED_VAR_AGG_MAX, RESERVED_VAR_AGG_MIN, RESERVED_VAR_AGG_SUM, RESERVED_VAR_AGGVAL_PREFIX, RESERVED_VAR_STRUCTURE_DEF

 

Fields inherited from interface oracle.jbo.expr.JIReservedVarNames
RESERVED_VAR_VALUE

 

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable
XML_STATEMENT

 

Constructor Summary
BoundParameter()
           
BoundParameter(java.lang.String name)
           

 

Method Summary
 DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
           
 DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
           
 java.lang.String getAttributeName()
          If this BoundParameter maps to an attribute, returns the name of mapped attribute.
 java.lang.String getDefXMLElementTag()
           
 java.lang.String getDefXMLNameSpace()
           
 java.lang.String getFullName()
          Gets this object's fully-qualified name.
 java.lang.Class getJavaType()
          Returns the Java type of the attribute.
protected  java.lang.String getMappedValue(java.util.HashMap initValues)
           
 java.lang.String getRequired()
          For internal framework use only.
 int getSQLType()
          Overridden to return -1;
 VariableManagerOwner getVariableManagerOwner()
           
 boolean isUnmapped()
          Test if the underlying variable is unmapped
 void loadXMLContents(DefElement xmlElement)
           
static void loadXMLParameterContents(DefElement xmlElement, java.util.HashMap valueTab)
          This method loads a variable value mapping Element into a map.
 void setVariableManagerOwner(VariableManagerOwner owner)
           
 void writeChildren(DefWriter jos)
          Writes the Object's children to the Persistent storage
 void writeContents(DefWriter jos)
          Objects should write their persistence output in this method

 

Methods inherited from class oracle.jbo.common.VariableImpl
_getDomainContext, addValidator, applyDiffChildren, applyDiffContents, clone, convertToJava, createClone, diffObjects, displayInShortForm, ensureDifferDetails, evaluateTransientExpression, getAccessorVO, getAttributeKind, getCategory, getColumnName, getColumnNameForQuery, getColumnType, getCompOpers, getControlType, getDefaultValue, getDefinitionState, getDisplayHeight, getDisplayHint, getDisplayWidth, getElemSQLType, getElemType, getExprEval, getExtendedData, getFieldOrder, getFormat, getFormattedAttribute, getFormatter, getFormatterClassName, getHint, getHintValue, getIndex, getJavaTypeName, getLabel, getLabelPlural, getListBindingDef, getLocaleName, getLOVName, getOperators, getOrigObject, getPayloadHint, getPrecision, getResourceBundleDef, getResourcePrefix, getScale, getSerializerClassName, getSession, getStructureDef, getTooltip, getTransientExpression, getTransientExpressionDef, getUIHelper, getUpdateableFlag, getValidators, getValueSerializer, getVariableKind, getVariableManager, getXMLContentValue, getXMLElementTag, hasFormatInformation, initDefaultValueNoConversion, initFromXML, initFromXML, isAutoSubmit, isDefinedDefaultValue, isDirty, isDiscrColumn, isMandatory, isNew, isPassivationNeeded, isPrimaryKey, isQueriable, isSelected, loadCustomProperties, loadProperties, loadSchemaProperties, mergePropertyMap, parseFormattedAttribute, removeProperty, removeValidator, requiresNamePrefixedResId, setColumnType, setDefaultValue, setDirty, setElemType, setExtendedData, setJavaType, setJavaTypeName, setMandatory, setName, setNew, setOrigObject, setPassivationNeeded, setPrecisionScale, setProperty, setPropertyExpression, setPropertyMap, setSerializerClassName, setTransientExpression, setUpdateableFlag, setVariableKind, setVariableManager, writeObject

 

Methods inherited from class oracle.jbo.common.NamedObjectImpl
allocatePropertyMap, getAllProperties, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getPropertyMap, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, isPropertyExpression, refreshProperty, removeProperty, resolveObjectProperty, resolvePropertyRaw, setFullName, setParent, setPropertiesMap, setPropertiesMap2, setProperty

 

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface oracle.jbo.AttributeDef
getName

 

Methods inherited from interface oracle.jbo.Properties
getProperties, getProperty, getProperty, refreshProperty

 

Methods inherited from interface oracle.jbo.rules.ValidationManager
getName

 

Methods inherited from interface oracle.jbo.mom.DiffMergeable
getName

 

Field Detail

BPARAM_DIFF_STRING_ELEMS

protected static final java.lang.String[] BPARAM_DIFF_STRING_ELEMS

PARAM_REQUIRED

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

PARAM_SELECTIVELY_REQUIRED

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

PARAM_OPTIONAL

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

Constructor Detail

BoundParameter

public BoundParameter()

BoundParameter

public BoundParameter(java.lang.String name)

Method Detail

getFullName

public java.lang.String getFullName()
Description copied from class: NamedObjectImpl
Gets this object's fully-qualified name.
Specified by:
getFullName in interface DiffMergeable
Specified by:
getFullName in interface DefPersistable
Specified by:
getFullName in interface ValidationManager
Overrides:
getFullName in class NamedObjectImpl
Returns:
this object's fully-qualified name; the package name concatenated with the class name.

writeContents

public void writeContents(DefWriter jos)
Description copied from interface: PersistentDefinition
Objects should write their persistence output in this method
Specified by:
writeContents in interface PersistentDefinition
Overrides:
writeContents in class VariableImpl
Parameters:
jos - the Output storage for persistence

writeChildren

public void writeChildren(DefWriter jos)
Description copied from interface: PersistentDefinition
Writes the Object's children to the Persistent storage
Specified by:
writeChildren in interface PersistentDefinition
Overrides:
writeChildren in class VariableImpl
Parameters:
jos - the Output storage for persistence

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()
Specified by:
getDefXMLElementTag in interface PersistentDefinition
Overrides:
getDefXMLElementTag in class VariableImpl

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()
Specified by:
getDefXMLNameSpace in interface PersistentDefinition
Overrides:
getDefXMLNameSpace in class VariableImpl

loadXMLParameterContents

public static void loadXMLParameterContents(DefElement xmlElement,
                                            java.util.HashMap valueTab)
This method loads a variable value mapping Element into a map. It also loads DCParameterDef's xml attribute into the map.
For internal use only. Application developers should not use this

loadXMLContents

public void loadXMLContents(DefElement xmlElement)

getMappedValue

protected java.lang.String getMappedValue(java.util.HashMap initValues)

getRequired

public java.lang.String getRequired()
For internal framework use only.
For internal use only. Application developers should not use this

getAttributeName

public java.lang.String getAttributeName()
If this BoundParameter maps to an attribute, returns the name of mapped attribute. Otherwise, return the viewcriteria variable name.
For internal use only. Application developers should not use this

isUnmapped

public boolean isUnmapped()
Test if the underlying variable is unmapped
Returns:
true, if the underlying variable is unmapped

setVariableManagerOwner

public void setVariableManagerOwner(VariableManagerOwner owner)

getVariableManagerOwner

public VariableManagerOwner getVariableManagerOwner()

getJavaType

public java.lang.Class getJavaType()
Description copied from class: VariableImpl
Returns the Java type of the attribute.

For example, if the attribute is of type String, this method returns java.lang.String; if it is of type Number, it returns oracle.jbo.domain.Number.

Subclasses should override this method because Entities without accessors should also be able to get their types from attribute descriptors and beans.

Specified by:
getJavaType in interface AttributeDef
Overrides:
getJavaType in class VariableImpl
Returns:
the attribute's Java class, or Object for attributes which have no accessor methods available.

getSQLType

public int getSQLType()
Description copied from class: VariableImpl
Overridden to return -1;
Specified by:
getSQLType in interface AttributeDef
Specified by:
getSQLType in interface Variable
Overrides:
getSQLType in class VariableImpl
Returns:
the JDBC type.
See Also:
Types

diffContents

public DifferDetails diffContents(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)
Specified by:
diffContents in interface DiffMergeable
Overrides:
diffContents in class VariableImpl

diffChildren

public DifferDetails diffChildren(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)
Specified by:
diffChildren in interface DiffMergeable
Overrides:
diffChildren in class VariableImpl

Skip navigation links

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

E52932-01


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