oracle.adf.view.rich.model

Interface ActiveDataModel

All Known Implementing Classes:

ActiveCollectionModelDecorator, ActiveScalarModelDecorator, ActiveTreeModelDecorator, BaseActiveDataModel

public interface ActiveDataModel

ActiveDataModel is the interface that all data models supporting pushing data must implement to take advantage of framework support for pushing data to the client.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ActiveDataModel.ActiveDataPolicy Supported active data policy

Method Summary

Modifier and Type	Method and Description
ActiveDataModel.ActiveDataPolicy	getActiveDataPolicy() Return the active data policy of the model
int	getCurrentChangeCount() Returns the current monotonically increasing change count for this ActiveDataModel
void	startActiveData(Collection<Object> rowKeys, int startChangeCount, ActiveDataListener listener) Called by the DataUpdateManager to notify the ActiveDataModel to start delivering change notifications for the collections of the containers identified by the rowKeys
void	stopActiveData(Collection<Object> rowKeys, ActiveDataListener listener) Called by the DataUpdateManager to notify the ActiveDataModel to stop delivering change notifications for the collections of the container identified by the given rowKeys

Method Detail

getActiveDataPolicy

ActiveDataModel.ActiveDataPolicy getActiveDataPolicy()

Return the active data policy of the model

Returns:

the active data policy of the model

See Also:

ActiveDataModel.ActiveDataPolicy

startActiveData

void startActiveData(Collection<Object> rowKeys,
                     int startChangeCount,
                     ActiveDataListener listener)

Called by the DataUpdateManager to notify the ActiveDataModel to start delivering change notifications for the collections of the containers identified by the rowKeys

Parameters:

rowKeys - the container row keys of the collection, from which the ActiveDataListener receives active events. Pass null or empty collection for for root collection.

startChangeCount - Change count to start sending active data from.

listener - ActiveDataListener for the ActiceDataModel to use when notifying the DataUpdateManager of changes

Throws:

IllegalStateException - if ActiveDataPolicy is STATIC

IllegalArgumentException - if listener is null or the startChangeCount is greater than the current change count.

See Also:

stopActiveData(java.util.Collection<java.lang.Object>, oracle.adf.view.rich.event.ActiveDataListener)

stopActiveData

void stopActiveData(Collection<Object> rowKeys,
                    ActiveDataListener listener)

Called by the DataUpdateManager to notify the ActiveDataModel to stop delivering change notifications for the collections of the container identified by the given rowKeys

Parameters:

rowKeys - the container row keys of the collections, from which the ActiveDataListener receives active events. Pass null or empty collection for for root collection.

listener - the ActiveDataListener to be removed ActiveDataListener receives active events. Pass null for root collection.

Throws:

IllegalStateException - If called on an ActiveDataModel that was never started by calling startActiveData

See Also:

startActiveData(java.util.Collection<java.lang.Object>, int, oracle.adf.view.rich.event.ActiveDataListener)

getCurrentChangeCount

int getCurrentChangeCount()

Returns the current monotonically increasing change count for this ActiveDataModel

Returns:

The current change count