oracle.adfnmc.bindings
Interface DataControl

All Known Subinterfaces:

TransactionalDataControl

All Known Implementing Classes:

GenericJavaBeanDataControlAdapter, WebServiceDataControlAdapter

public interface DataControl

An interface through which the Data Binding Facility interacts with a Service. An implementation of DataControl interface provides generic adaptation for a Service and Model technology. For example, a generic SessionBean DataControl can be written to handle interaction with any EJB session beans.
The DataControl is to be implemented by someone who is familiar with the service whose values and operations will be exposed to the view layer.
The DataControl is to be used exclusively by Tooling and the Data Binding facility to adapt different Services. It is not to be used directly by the View or Controller to access Services and Model.

Method Summary

java.lang.Object	getDataProvider() Returns the Business Service Object that this DataControl is associated with.
java.lang.Object	getDataProvider(XmlAnyDefinition metadataDef, BindingContainer bc) DRM - added this Get a named data provider within a service object or hierarchy that this DataControl is associated with.
BasicIterator	getIteratorBinding(java.lang.Object dataProvider, XmlAnyDefinition metadataDef, BindingContainer bc) DRM - added this Returns an iterator binding over the dataProvider object
XmlAnyDefinition	getMetadataDefinition() DRM - added this added for ADFNMC
java.lang.String	getName() Returns name to identify this datacontrol inside a BindingContext.
boolean	invokeOperation(Map bindingContext, OperationBinding action) All OperationBindings should first delegate to the DataControl associated with the binding to perform the action.
void	release() Releases the DataControl.
void	setDataProvider(java.lang.Object dataProvider) DRM - added this Sets the Business Service Object that this DataControl is associated with.
void	setMetadataDefinition(XmlAnyDefinition def) DRM - added this added for ADFNMC
void	setName(java.lang.String name) DRM - added this Sets the name that identifies this datacontrol inside a BindingContext.

Method Detail

getName

java.lang.String getName()

Returns name to identify this datacontrol inside a BindingContext.

setName

void setName(java.lang.String name)

DRM - added this
Sets the name that identifies this datacontrol inside a BindingContext.

release

void release()

Releases the DataControl. The DataControl should be in a collectable state after release() has been invoked.

This should close all open DataControl resources.

getMetadataDefinition

XmlAnyDefinition getMetadataDefinition()

DRM - added this
added for ADFNMC

Returns:

The metadata definition object for this Data Control

setMetadataDefinition

void setMetadataDefinition(XmlAnyDefinition def)

DRM - added this
added for ADFNMC

Parameters:

def - The metadata definition object for this binding object

getDataProvider

java.lang.Object getDataProvider()

Returns the Business Service Object that this DataControl is associated with.

Returns:

The underlying business service object.

setDataProvider

void setDataProvider(java.lang.Object dataProvider)

DRM - added this
Sets the Business Service Object that this DataControl is associated with.

getDataProvider

java.lang.Object getDataProvider(XmlAnyDefinition metadataDef,
                                 BindingContainer bc)

DRM - added this
Get a named data provider within a service object or hierarchy that this DataControl is associated with.

Parameters:

metadataDef - The metadata representation of the iterator binding to the data provider object in the functional service object or object hierarchy.

bc - The BindingContainer from which the iterator binding instance for the masterIterator Id can be retrieved.

getIteratorBinding

BasicIterator getIteratorBinding(java.lang.Object dataProvider,
                                 XmlAnyDefinition metadataDef,
                                 BindingContainer bc)

DRM - added this
Returns an iterator binding over the dataProvider object

Parameters:

dataProvider - The data provider object in the functional service object or object hierarchy to wrap with a GenericIteratorBinding interface

metadataDef - The metadata representation of the iterator binding to return

bc - The BindingContainer from which the iterator binding instance for iteratorId is (or will be) contained.

invokeOperation

boolean invokeOperation(Map bindingContext,
                        OperationBinding action)

All OperationBindings should first delegate to the DataControl associated with the binding to perform the action. DataControls may choose to interpret a given action differently based on the data/collection that action is bound to.

Returns:

true if this datacontrol has handled this action, false if the action should be interpreted in the bindings framework or in the caller.