Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.2.0)

E17483-03


oracle.adf.model.adapter.bean.jpa
Class JPQLManagedDCHandler

java.lang.Object
  extended by oracle.adf.model.adapter.bean.DataFilterHandler
      extended by oracle.adf.model.adapter.bean.jpa.JPQLDataFilterHandler
          extended by oracle.adf.model.adapter.bean.jpa.JPQLManagedDCHandler

All Implemented Interfaces:
CriteriaHandler, DataControl, FilterableDataControl, ManagedDataControl

public class JPQLManagedDCHandler
extends JPQLDataFilterHandler
implements ManagedDataControl
Since:
11.1.1.2

Field Summary

 

Fields inherited from class oracle.adf.model.adapter.bean.DataFilterHandler
_beanDataProvider, _dc, _logger

 

Constructor Summary
JPQLManagedDCHandler(DataControl dataControl)
           

 

Method Summary
 void beginRequest(java.util.HashMap requestCtx)
          Invoked in some contexts to signal the beginning of a model request.
 java.io.Serializable createSnapshot()
          Creates a snapshot of the state of the DataControl.
 void endRequest(java.util.HashMap requestCtx)
          Invoked in some contexts to signal the end of a model request.
 java.lang.Object getDataProvider()
          Returns the Business Service Object that this datacontrol is associated with.
 java.lang.String getName()
          Returns name to identify this datacontrol inside a BindingContext.
 boolean invokeOperation(java.util.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 removeSnapshot(java.io.Serializable handle)
          Removes the snapshot associated with the snapshot handle.
 boolean resetState()
          Resets the DataControl.
 void restoreSnapshot(java.io.Serializable handle)
          Restore the state of the DataControl with the snapshot state that is referenced by the handle.

 

Methods inherited from class oracle.adf.model.adapter.bean.jpa.JPQLDataFilterHandler
getHandlerMethodNames, invoke, invoke, supportsCriteria, supportsPaging, supportsSorting

 

Methods inherited from class oracle.adf.model.adapter.bean.DataFilterHandler
invokeAccessor, invokeOperation

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

JPQLManagedDCHandler

public JPQLManagedDCHandler(DataControl dataControl)

Method Detail

createSnapshot

public java.io.Serializable createSnapshot()
Description copied from interface: ManagedDataControl
Creates a snapshot of the state of the DataControl. A snapshot may be used to save the DataControl state so that it may be restored some time later. Returns a serializable handle to the snapshot.
Returns:
a snapshot handle

restoreSnapshot

public void restoreSnapshot(java.io.Serializable handle)
Description copied from interface: ManagedDataControl
Restore the state of the DataControl with the snapshot state that is referenced by the handle.
Parameters:
handle - Serializable a snaphsot handle that was created with ManagedDataControl.createSnapshot().

removeSnapshot

public void removeSnapshot(java.io.Serializable handle)
Description copied from interface: ManagedDataControl
Removes the snapshot associated with the snapshot handle.
Parameters:
handle - Serializable a snapshot handle that was created with ManagedDataControl.createSnapshot().

getName

public java.lang.String getName()
Description copied from interface: DataControl
Returns name to identify this datacontrol inside a BindingContext.
Specified by:
getName in interface DataControl

release

public void release()
Description copied from interface: DataControl
Releases the DataControl. The DataControl should be in a collectable state after release() has been invokd.

This should close all open DataControl resources.

Specified by:
release in interface DataControl

getDataProvider

public java.lang.Object getDataProvider()
Description copied from interface: DataControl
Returns the Business Service Object that this datacontrol is associated with.
Specified by:
getDataProvider in interface DataControl
Returns:
The underlying business service object.

invokeOperation

public boolean invokeOperation(java.util.Map bindingContext,
                               OperationBinding action)
Description copied from interface: DataControl
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.
Specified by:
invokeOperation in interface DataControl
Returns:
true if this datacontrol has handled this action, false if the action should be interpreted in the bindings framework or in the caller.

beginRequest

public void beginRequest(java.util.HashMap requestCtx)
Description copied from interface: ManagedDataControl
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 Binding Facilities before control is forwarded to the first Servlet defined by the request.

Datacontrols may implement this method to perform request level initialization.

This method is to be called only once per request. For example, in web applications, page forwards should not result in multiple invocations of this method.

Specified by:
beginRequest in interface ManagedDataControl
Parameters:
requestCtx - a HashMap representing request context.

endRequest

public void endRequest(java.util.HashMap requestCtx)
Description copied from interface: ManagedDataControl
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 Binding Facilities after control is returned from the last Servlet defined by the request page flow.

Datacontrols may implement this method to perform request level cleanup.

This method is to be called only once per request. For example, in web applications, page forwards should not result in multiple invocations of this method.

Specified by:
endRequest in interface ManagedDataControl
Parameters:
requestCtx - a HashMap representing request context.

resetState

public boolean resetState()
Description copied from interface: ManagedDataControl
Resets the DataControl. DataControl implementation can reset any model session state that maay have been managed by this data control in this method.

For example, an EJB DataControl provider may extend resetState to close the DataControl EJB SessionBean

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.

Specified by:
resetState in interface ManagedDataControl
Returns:
true if resetState was processed immediately. false if resetState was deferred to endRequest processing.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.2.0)

E17483-03


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