oracle.adf.model
Interface ManagedDataControl

All Superinterfaces:

DataControl, java.util.Map

public interface ManagedDataControl

extends DataControl

ManagedDataControl

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

Fields inherited from interface oracle.adf.model.DataControl

REL_ALL_REFS, REL_DATA_REFS, REL_VIEW_REFS, REL_WEAK_DATA_REFS

Method Summary

void	beginRequest(java.util.HashMap requestCtx) Invoked in some contexts to signal the beginning of a model request.
void	endRequest(java.util.HashMap requestCtx) Invoked in some contexts to signal the end of a model request.
boolean	resetState() Resets the DataControl.

Methods inherited from interface oracle.adf.model.DataControl

getDataProvider, getName, release

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

beginRequest

public void beginRequest(java.util.HashMap requestCtx)

Invoked in some contexts to signal the beginning of a model request. For example, if the DataControl is referenced in a web application then this method will be invoked by the ADF framework before control is forwarded to the first Servlet defined by the request.

Subclassing datacontrols may extend this method to perform request level initialization of the DataControl.

This method is guaranteed to be called only once per browser request. Page forwards should not result in multiple invocations.

Parameters:

requestCtx - a HashMap representing request context. Web applications which require request context may use the BindingContext.HTTP_REQUEST and BindingContext.HTTP_RESPONSE keys to acquire a reference from from the BindingContext.

endRequest

public void endRequest(java.util.HashMap requestCtx)

Invoked in some contexts to signal the end of a model request. For example, if the DataControl is referenced in a web application then this method will be invoked by the ADF framework after control is returned from the last Servlet defined by the request page flow.

Subclassing datacontrols may extend this method to perform request level cleanup of the DataControl.

This method is guaranteed to be called only once per browser request. Page forwards should not result in multiple invocations.

Parameters:

requestCtx - a HashMap representing request context. Web applications which require request context may use the BindingContext.HTTP_REQUEST and BindingContext.HTTP_RESPONSE keys to acquire a reference from from the BindingContext.

resetState

public boolean resetState()

Resets the DataControl. DataControl providers should extend this method to reset any model session state that may have been managed by this DataControl. For example:

The ADF/BC DataControl has extended resetState to release the DataControl ApplicationModule to the ApplicationPool in unmanaged release mode.

An EJB DataControl provider may extend resetState to close the DataControl EJB SessionBean

A Toplink DataControl provider may extend resetState to close the DataControl UnitOfWork or ClientSession.

Please note that resetState may not occur immediately. If beginRequest has been invoked on the DataControl then resetState processing will be deferred until endRequest processing.

Extending DataControl providers should invoke release(REL_DATA_REFS) after performing and DataControl specific resetState handling.

Returns:

true if resetState was processed immediately. false if resetState was deferred to endRequest processing.