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

E10653-05

oracle.adf.model.binding
Class DCIteratorBindingDef

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.DCExecutableBindingDef
                      extended by oracle.adf.model.binding.DCIteratorBindingDef
All Implemented Interfaces:
DefPersistable, PersistentDefinition
Direct Known Subclasses:
JUIteratorDef

public abstract class DCIteratorBindingDef
extends DCExecutableBindingDef


Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject
PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType
 
Field Summary
static int EXECUTABLE_ACTION
           
static int EXECUTABLE_ITERATORBINDING
           
static int EXECUTABLE_REGION
           
protected  int mChangeEventRate
           
protected  int mRangeSize
           
static java.lang.String PNAME_RangeSize
           
static java.lang.String PNAME_TYPE
           
 
Fields inherited from class oracle.adf.model.binding.DCExecutableBindingDef
PNAME_option, PNAME_option_ALWAYS, PNAME_option_DEFAULT, PNAME_option_DEFER, PNAME_option_IF_NEEDED, PNAME_option_NEVER, PNAME_option_PREPARE, PNAME_option_PREPARE_OPT, PNAME_option_REFRESH, PNAME_option_REFRESH_OPT, PNAME_option_RENDER, PNAME_option_RENDER_OPT, PNAME_optionExpr, PNAME_refreshAfter, RC_ALWAYS, RC_DEFAULT, RC_DEFER, RC_NEVER, RC_PREPARE, RC_PREPARE_OPT, RC_REFRESH, RC_REFRESH_OPT, RC_RENDER, RC_RENDER_OPT, RC_UNINIT
 
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, PROPERTY_EXPRMAP
 
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
DCIteratorBindingDef()
           
DCIteratorBindingDef(java.lang.String name, java.lang.String amName, java.lang.String voName, java.lang.String rsiName, int rangeSize)
           
 
Method Summary
 java.lang.Object createExecutableBinding(BindingContext ctx, DCBindingContainer bc)
          Create an executable binding instance based on this definition in the given BindingContainer.
abstract  DCIteratorBinding createIterBinding(BindingContext ctx, DCBindingContainer bindingContainer)
           
abstract  DCIteratorBinding createIterBinding(BindingContext ctx, DCBindingContainer bindingContainer, ApplicationModule anchorAM)
           
 java.lang.String getAMName()
           
 java.lang.String getBindsName()
           
 DataControl.DataChangeEventPolicy getChangeEventPolicy()
           
 int getChangeEventRate()
           
 java.lang.String getDataControlName()
           
 java.lang.String getDesignTimeClass()
           
 int getExecutableType()
          Return EXECUTABLE_REGION, EXECUTABLE_ITERATORBINDING or EXECUTABLE_ACTION based on what kind of binding this definition creates.
protected  byte getLevel()
           
 java.lang.String getName()
           
protected  java.lang.String getPermissionClassName()
          Internal: Applications should not use this method.
protected  java.lang.String getPermissionTargetName()
          Internal: Applications should not use this method.
 int getRangeSize()
           
protected  DCIteratorBinding.RenderHintTypes getRenderHint()
           
 long getRowCountThreshold()
          Internal: Applications should not use this method.
 java.lang.String getRSIName()
           
 SortCriteria[] getSortCriteria()
           
 java.lang.String getXMLElementTag()
          Returns a piece of static info for the type of object this is invoked upon.
 void init(java.util.HashMap initValues)
          Internal: Applications should not use this method.
 void initializeExecutableBinding(BindingContext ctx, DCBindingContainer bindingContainer, java.lang.Object binding)
          Internal: Applications should not use this method.
 boolean isCacheResults()
           
 boolean isObjectType()
           
 boolean isSortable()
           
 boolean isStateValidationEnabled()
          Internal: Applications should not use this method.
 void loadChildrenFromXML(DefElement xmlElement)
           
protected  void retrieveFromXML(DefElement xmlElement, java.util.HashMap valueTab)
          Internal: Applications should not use this method.
 void setBindingContainerDef(DCBindingContainerDef formDef)
           
protected  void setCacheResults(boolean flag)
           
 void setStateValidationEnabled(boolean enable)
          Internal: Applications should not use this method.
 
Methods inherited from class oracle.adf.model.binding.DCExecutableBindingDef
getDependencyNames, getRefreshExpression, getRefreshOption, getRefreshOptionValue, internalGetRefreshOptionFromString, internalHasPermission, isRefreshable, isRefreshable
 
Methods inherited from class oracle.adf.model.binding.DCDefBase
convertToBoolean, convertToDataChangePolicy, convertToInt, convertToIntArray, convertToLong, createAndLoadFromXML, getDefClassName, getDefTypeId, getDefXMLNameSpace, getOrigObject, getPermissionDef, getPersonalizer, getPersonalizerClass, getSubType, initSubType, 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, isCustomizationEnabled, isCustomizationEnabled, isEditable, isPersonalizationEnabled, isPersonalizationEnabled, loadDefImports, mergePropertyMap, objectRemoved, registerClass, registerDefObject, registerSessionDefObject, remove, removeAndDelete, removeDefImport, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setEditable, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, 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, getPropertyExpressionsMap, getResourcesFromBundle, getStringFromMessageBundle, isPropertyExpression, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, 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

mRangeSize

protected int mRangeSize

mChangeEventRate

protected int mChangeEventRate

PNAME_RangeSize

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

PNAME_TYPE

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

EXECUTABLE_REGION

public static final int EXECUTABLE_REGION
See Also:
Constant Field Values

EXECUTABLE_ITERATORBINDING

public static final int EXECUTABLE_ITERATORBINDING
See Also:
Constant Field Values

EXECUTABLE_ACTION

public static final int EXECUTABLE_ACTION
See Also:
Constant Field Values
Constructor Detail

DCIteratorBindingDef

public DCIteratorBindingDef()

DCIteratorBindingDef

public DCIteratorBindingDef(java.lang.String name,
                            java.lang.String amName,
                            java.lang.String voName,
                            java.lang.String rsiName,
                            int rangeSize)
Method Detail

getLevel

protected byte getLevel()

getDesignTimeClass

public java.lang.String getDesignTimeClass()

getSortCriteria

public SortCriteria[] getSortCriteria()

init

public void init(java.util.HashMap initValues)
Description copied from class: DCExecutableBindingDef
Internal: Applications should not use this method.

Overrides:
init in class DCExecutableBindingDef

isObjectType

public boolean isObjectType()

getRangeSize

public int getRangeSize()

getChangeEventRate

public int getChangeEventRate()
Returns:
ChangeEventRate. If no value is set for this property, then returns -1.

getRowCountThreshold

public long getRowCountThreshold()
Internal: Applications should not use this method.


isSortable

public boolean isSortable()

isCacheResults

public boolean isCacheResults()

isStateValidationEnabled

public boolean isStateValidationEnabled()
Internal: Applications should not use this method.


setStateValidationEnabled

public void setStateValidationEnabled(boolean enable)
Internal: Applications should not use this method.


setBindingContainerDef

public void setBindingContainerDef(DCBindingContainerDef formDef)

getAMName

public java.lang.String getAMName()

getBindsName

public java.lang.String getBindsName()

getRSIName

public java.lang.String getRSIName()

getXMLElementTag

public java.lang.String getXMLElementTag()
Description copied from interface: PersistentDefinition
Returns a piece of static info for the type of object this is invoked upon. Examples are PreparedStatements for insert, update, delete, and String containing a base the select statement for retrieving instances of this type through the SQLInputStream

Specified by:
getXMLElementTag in interface PersistentDefinition
Overrides:
getXMLElementTag in class DCExecutableBindingDef
Returns:
returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

getDataControlName

public java.lang.String getDataControlName()

getExecutableType

public int getExecutableType()
Return EXECUTABLE_REGION, EXECUTABLE_ITERATORBINDING or EXECUTABLE_ACTION based on what kind of binding this definition creates.

Specified by:
getExecutableType in class DCExecutableBindingDef

createIterBinding

public abstract DCIteratorBinding createIterBinding(BindingContext ctx,
                                                    DCBindingContainer bindingContainer,
                                                    ApplicationModule anchorAM)

createIterBinding

public abstract DCIteratorBinding createIterBinding(BindingContext ctx,
                                                    DCBindingContainer bindingContainer)

retrieveFromXML

protected void retrieveFromXML(DefElement xmlElement,
                               java.util.HashMap valueTab)
Description copied from class: DCExecutableBindingDef
Internal: Applications should not use this method.

Overrides:
retrieveFromXML in class DCExecutableBindingDef

loadChildrenFromXML

public void loadChildrenFromXML(DefElement xmlElement)
Overrides:
loadChildrenFromXML in class DCDefBase

createExecutableBinding

public java.lang.Object createExecutableBinding(BindingContext ctx,
                                                DCBindingContainer bc)
Create an executable binding instance based on this definition in the given BindingContainer.

Specified by:
createExecutableBinding in class DCExecutableBindingDef

initializeExecutableBinding

public void initializeExecutableBinding(BindingContext ctx,
                                        DCBindingContainer bindingContainer,
                                        java.lang.Object binding)
Description copied from class: DCExecutableBindingDef
Internal: Applications should not use this method.

Overrides:
initializeExecutableBinding in class DCExecutableBindingDef

getPermissionTargetName

protected java.lang.String getPermissionTargetName()
Description copied from class: DCExecutableBindingDef
Internal: Applications should not use this method.

Overrides:
getPermissionTargetName in class DCExecutableBindingDef

getPermissionClassName

protected java.lang.String getPermissionClassName()
Description copied from class: DCExecutableBindingDef
Internal: Applications should not use this method.

Overrides:
getPermissionClassName in class DCExecutableBindingDef

setCacheResults

protected void setCacheResults(boolean flag)

getRenderHint

protected DCIteratorBinding.RenderHintTypes getRenderHint()

getChangeEventPolicy

public DataControl.DataChangeEventPolicy getChangeEventPolicy()

getName

public java.lang.String getName()

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

E10653-05

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