Oracle Application Development Framework Model and Business Components Java API Reference 10.1.3.1.0
B28969-01


oracle.binding
Interface BindingContainer

All Superinterfaces:
java.util.Map

public interface BindingContainer
extends java.util.Map

The BindingContainer contains the Control Bindings for a reusable unit of View technology. For example, each individual Page, Region, or Panel refers to a unique BindingContainer with a set of Control Bindings that refer to the Model elements used by that Page. The BindingContainer interface is implemented by the data binding framework provider.


Nested Class Summary

 

Nested classes inherited from class java.util.Map
java.util.Map.Entry

 

Method Summary
 java.util.List getAttributeBindings()
          Return a list of all AttributeBinding and AttributesBinding in this RegionBinding.
 ControlBinding getControlBinding(java.lang.String name)
          Returns a control binding with the given name.
 java.util.List getControlBindings()
          Return a list of all control bindings in this RegionBinding.
 java.lang.String getName()
          Returns the name to identify this instance of the Region within it's container (BindingContext at the top level).
 OperationBinding getOperationBinding(java.lang.String name)
          Returns an operation binding with the given name.
 java.util.List getOperationBindings()
          Return a list of all Action bindings in this RegionBinding.
 java.lang.String getStateToken()
          Returns the state token.
 boolean isTokenValidationEnabled()
          Returns true if token validation is enabled for this RegionBinding.
 void refresh()
          Refreshes the DataControl by iteratively re-evaluating the executable bindings.
 void release(int flags)
          Releases this ControlBinding.
 void validate()
          Calls DataControl validate() for each data control that has a collection to which an iterator binding in this container or it's containeeds are bound to.
 void validateToken(java.lang.String sState)
          Validates that this RegionBindings is in the same state as represented by the given string token.

 

Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

 

Method Detail

getName

public java.lang.String getName()
Returns the name to identify this instance of the Region within it's container (BindingContext at the top level).

release

public void release(int flags)
Releases this ControlBinding. This method is called when the view component has finished using this ControlBinding.
Parameters:
flags - specifies what references should be released. See DataControl for valid values.
See Also:
DataControl.REL_ALL_REFS, DataControl.REL_DATA_REFS, DataControl.REL_VIEW_REFS, DataControl.REL_WEAK_DATA_REFS

refresh

public void refresh()
Refreshes the DataControl by iteratively re-evaluating the executable bindings. This method is called by the Controller to initialize and perpare the Bindings. This method can be called anytime. If the bindings have already been evaluated, and no state has changed, they should not re-execute.

getControlBinding

public ControlBinding getControlBinding(java.lang.String name)
Returns a control binding with the given name. Returns null if name is not found.
Parameters:
name -
Returns:
ControlBinding that matches the given name

getOperationBinding

public OperationBinding getOperationBinding(java.lang.String name)
Returns an operation binding with the given name. Returns null if name is not found. This is a typed accessor that can be used instead of getControlBinding() to get to an action binding in this region.
Parameters:
name -
Returns:
ControlBinding that matches the given name

getControlBindings

public java.util.List getControlBindings()
Return a list of all control bindings in this RegionBinding.

getAttributeBindings

public java.util.List getAttributeBindings()
Return a list of all AttributeBinding and AttributesBinding in this RegionBinding.

getOperationBindings

public java.util.List getOperationBindings()
Return a list of all Action bindings in this RegionBinding.

validate

public void validate()
Calls DataControl validate() for each data control that has a collection to which an iterator binding in this container or it's containeeds are bound to.

isTokenValidationEnabled

public boolean isTokenValidationEnabled()
Returns true if token validation is enabled for this RegionBinding. A token can be used to identify the current state of the Bindings.
For example, a token can be use in a web application to verify that the bindings are in the same state as the token implies, and only then are values updated. This also avoids multiple updates due to continuous button clicks that users tend to do in a web application.
Returns:
true if token validation is enabled for this RegionBinding, false otherwise.

validateToken

public void validateToken(java.lang.String sState)
Validates that this RegionBindings is in the same state as represented by the given string token.
Parameters:
sState - State that this RegionBinding should be in.

getStateToken

public java.lang.String getStateToken()
Returns the state token.
Returns:
String The state token representing the current state of this RegionBinding.

Oracle Application Development Framework Model and Business Components Java API Reference 10.1.3.1.0
B28969-01


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