oracle.adfmf.bindings

Interface DataControl

All Known Subinterfaces:

TransactionalDataControl

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

Modifier and Type	Method and Description
default void	addSelectionListener(String iteratorId, oracle.adfmf.bindings.event.SelectedRowKeysSelectionListener listener) Register a listener to be notified when the selected row keys for an iterator are being set
Object	createDataProvider(oracle.adfmf.util.XmlAnyDefinition metadataDef) Create a new instance of a provider type associated with this DataControl.
int	getCurrentRowForIterator(String iteratorId)
Object	getDataProvider() Returns the Business Service Object that this DataControl is associated with.
Object	getDataProvider(oracle.adfmf.util.XmlAnyDefinition metadataDef, BindingContainer bc) Get a named data provider within a service object or hierarchy that this DataControl is associated with.
BasicIterator	getIteratorBinding(Object dataProvider, oracle.adfmf.util.XmlAnyDefinition metadataDef, BindingContainer bc) Returns an iterator binding over the dataProvider object
oracle.adfmf.util.XmlAnyDefinition	getMetadataDefinition() Get the metadata definition object for this Data Control
String	getName() Returns name to identify this datacontrol inside a BindingContext.
Object[]	getSelectedRowKeyForIterator(String iteratorId)
boolean	invokeOperation(java.util.Map bindingContext, OperationBinding action) All OperationBindings should first delegate to the DataControl associated with the binding to perform the action.
boolean	isSecuredSharedInstance()
boolean	isSharedInstance()
void	release() Releases the DataControl.
default void	removeSelectionListener(String iteratorId, oracle.adfmf.bindings.event.SelectedRowKeysSelectionListener listener) Remove a listener
void	setCurrentRowForIterator(String iteratorId, int rowIndex)
void	setDataProvider(Object dataProvider) Sets the Business Service Object that this DataControl is associated with.
void	setMetadataDefinition(oracle.adfmf.util.XmlAnyDefinition def) Set the metadata definition object for this Data Control
void	setName(String name) Sets the name that identifies this datacontrol inside a BindingContext.
void	setSecuredSharedInstance(boolean isSecuredSharedInstance)
void	setSelectedRowKeyForIterator(String iteratorId, Object[] keys) Preserves selected row (one per iterator) in the data control so it can be restored after navigation.
void	setSharedInstance(boolean isSharedInstance)

Method Detail

getName

String getName()

Returns name to identify this datacontrol inside a BindingContext.

setName

void setName(String name)

Sets the name that identifies this datacontrol inside a BindingContext.

Since:

ADFMF

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

oracle.adfmf.util.XmlAnyDefinition getMetadataDefinition()

Get the metadata definition object for this Data Control

Since:

ADFMF

setMetadataDefinition

void setMetadataDefinition(oracle.adfmf.util.XmlAnyDefinition def)

Set the metadata definition object for this Data Control

Parameters:

def - The metadata definition object for this binding object

Since:

ADFMF

createDataProvider

Object createDataProvider(oracle.adfmf.util.XmlAnyDefinition metadataDef)

Create a new instance of a provider type associated with this DataControl.

Parameters:

metadataDef - A metadata definition object that includes information about the type create (i.e. a child type associated with an accessorIterator definition). If null, creates a new instance of the root provider type.

Since:

ADFMF

getDataProvider

Object getDataProvider()

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

Returns:

The underlying business service object.

setDataProvider

void setDataProvider(Object dataProvider)

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

Since:

ADFMF

getDataProvider

Object getDataProvider(oracle.adfmf.util.XmlAnyDefinition metadataDef,
                       BindingContainer bc)

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.

Since:

ADFMF

getIteratorBinding

BasicIterator getIteratorBinding(Object dataProvider,
                                 oracle.adfmf.util.XmlAnyDefinition metadataDef,
                                 BindingContainer bc)

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.

Since:

ADFMF

invokeOperation

boolean invokeOperation(java.util.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.

setCurrentRowForIterator

void setCurrentRowForIterator(String iteratorId,
                              int rowIndex)

getCurrentRowForIterator

int getCurrentRowForIterator(String iteratorId)

setSelectedRowKeyForIterator

void setSelectedRowKeyForIterator(String iteratorId,
                                  Object[] keys)

Preserves selected row (one per iterator) in the data control so it can be restored after navigation.

Parameters:

iteratorId - the id of the iterator that was selected

keys - an array containing a selected key

getSelectedRowKeyForIterator

Object[] getSelectedRowKeyForIterator(String iteratorId)

Parameters:

iteratorId - the id of the iterator for the selected row

Returns:

an array containing row key selected for this iterator, or null, if no selection was made

isSharedInstance

boolean isSharedInstance()

Returns:

true, if a single instance of this data control is shared by all the features in the application

setSharedInstance

void setSharedInstance(boolean isSharedInstance)

Parameters:

isSharedInstance -

isSecuredSharedInstance

boolean isSecuredSharedInstance()

Returns:

true, if this data control should be accessed by secured features only, false otherwise.

setSecuredSharedInstance

void setSecuredSharedInstance(boolean isSecuredSharedInstance)

Parameters:

isSecuredSharedInstance -

addSelectionListener

default void addSelectionListener(String iteratorId,
                                  oracle.adfmf.bindings.event.SelectedRowKeysSelectionListener listener)

Register a listener to be notified when the selected row keys for an iterator are being set

Parameters:

iteratorId - the ID of the iterator for which the keys are being changed

listener - the listener to be notified

removeSelectionListener

default void removeSelectionListener(String iteratorId,
                                     oracle.adfmf.bindings.event.SelectedRowKeysSelectionListener listener)

Remove a listener

Parameters:

iteratorId - the iterator ID to stop listener for changes

listener - the listener