|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.adf.model.dcframe.DataControlFrameImpl
public class DataControlFrameImpl
Constructor Summary | |
---|---|
DataControlFrameImpl(java.lang.String name,
DataControlFrameImpl parentFrame,
java.util.List<DataControlPolicy> policies,
DataControlPolicy defaultPolicy,
BindingContext bindingContext)
Constructor |
Method Summary | |
---|---|
void |
addDataControl(java.lang.Object key,
DCDataControl dc)
Add an datacontrol to the list of datacontrols that this datacontrol frame should maintain. |
boolean |
addDataControlPolicy(DataControlPolicy policy)
Adds a datacontrol policy to this datacontrol frame. |
void |
beginRequest(BindingContext bindingCtx,
java.util.HashMap requestCtx)
|
void |
beginTransaction(TransactionProperties properties)
Begin a new transaction. |
void |
commit()
Commit the current underlying transaction. |
boolean |
containsBindingContainer(java.lang.Object bc)
|
boolean |
containsDataControl(java.lang.Object dc)
|
SavepointHandle |
createSavepoint()
Create a savepoint marking the current state of the task flow context. |
java.io.Serializable |
createSnapshot()
Internal use only. |
java.util.Collection<DCDataControl> |
datacontrols()
Returns the set of data controls in the frame |
void |
endRequest(BindingContext bindingCtx,
java.util.HashMap requestCtx)
|
DCDataControl |
findDataControl(java.lang.String dcName)
Retrieve a datacontrol instance with the given name from this datacontrol frame. |
DCDataControl |
findDataControl(java.lang.String dcName,
boolean create)
|
DCDataControl |
findDataControl(java.lang.String dcUsageName,
java.lang.String dcName,
boolean create)
|
DataControlPolicy |
findPolicy(java.lang.String name)
Retrieve a datacontrol policy with the given name from this datacontrol frame. |
java.lang.String |
findUniqueKey(java.lang.String key,
java.util.Map dcMap)
Return a key that is unique among the keys for datacontrols in the BindingContext. |
DCBindingContainer |
getBindingContainer(java.lang.Object key)
|
java.util.Collection<DCBindingContainer> |
getBindingContainers()
|
DataControlPolicy |
getDefaultPolicy()
Return the default datacontrol policy of this datacontrol frame. |
java.lang.String |
getName()
|
java.lang.String |
getOpenTransactionName()
Returns the name of the transaction if a transaction is open in this datacontrol frame. |
java.util.concurrent.locks.ReentrantLock |
getSyncLock()
|
boolean |
isTransactionDirty()
Indicates if unsaved data modifications exists within the current datacontrol frame. |
boolean |
isTransactionOpen()
Whether there is an open transaction in this frame, ie, whether beginTransaction has been called on this frame which has not been committed or rolled back. |
DCBindingContainer |
putBindingContainer(java.lang.Object key,
DCBindingContainer bc)
|
void |
release()
Release the datacontrol frame. |
void |
releaseSavepoint(SavepointHandle handle)
Release a save point when it is no longer needed. |
DCBindingContainer |
removeBindingContainer(java.lang.Object key)
|
void |
removeDataControl(java.lang.Object key)
|
void |
removeSnapshot(java.io.Serializable handle)
Internal use only. |
void |
restoreSavepoint(SavepointHandle handle)
Restore the transaction back to a previously created checkpoint. |
void |
restoreSnapshot(java.io.Serializable handle)
Internal use only. |
void |
resumeTransaction()
Resume the transaction associated with with this context. |
void |
rollback()
Rollback the underlying transaction. |
void |
setCurrent(boolean isCurrent)
Notify the frame that it has been set current. |
void |
suspendTransaction()
Called to suspend the transaction associated with this datacontrol frame. |
void |
unlock()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DataControlFrameImpl(java.lang.String name, DataControlFrameImpl parentFrame, java.util.List<DataControlPolicy> policies, DataControlPolicy defaultPolicy, BindingContext bindingContext)
name
- Name of this frame.policies
- An optional list of DataControlPolicy objects for
datacontrols that have different policies than the
default policy.defaultPolicy
- The default DataControlPolicy for all datacontrols
in this datacontrol frame.bindingContext
- the BindingContext that creates this frame.Method Detail |
---|
public void release()
release
in interface DataControlFrame
public java.util.concurrent.locks.ReentrantLock getSyncLock()
public void unlock()
public void setCurrent(boolean isCurrent)
public void beginRequest(BindingContext bindingCtx, java.util.HashMap requestCtx)
public void endRequest(BindingContext bindingCtx, java.util.HashMap requestCtx)
public final java.util.Collection<DCDataControl> datacontrols()
DataControlFrame
datacontrols
in interface DataControlFrame
public SavepointHandle createSavepoint()
createSavepoint
in interface DataControlFrame
public void restoreSavepoint(SavepointHandle handle)
restoreSavepoint
in interface DataControlFrame
cp
- the checkpoint to return to. Must have been created by a call
to createSavepoint()
on the same transaction.public void releaseSavepoint(SavepointHandle handle)
releaseSavepoint
in interface DataControlFrame
cp
- the savepoint to release. Must have been created by a call
to createSavepoint()
on the same transaction.public java.io.Serializable createSnapshot()
removeSnapshot(java.io.Serializable)
once the snapshot is no longer needed. Not
invoking removeSnapshot will result in an accumulation of snapshots
in the durable snapshot store.
Applications should not invoke this directly. Instead,
applications should use ADFc TaskFlows to declaratively work with
snapshots.
createSnapshot
in interface DataControlFrame
public void restoreSnapshot(java.io.Serializable handle)
createSnapshot()
. After restore the BindingContext state
will be equivalent to the state when createSnapshot was invoked.
Applications should not invoke this directly. Instead,
applications should use ADFc TaskFlows to declaratively work with
snapshots.
restoreSnapshot
in interface DataControlFrame
handle
- public void removeSnapshot(java.io.Serializable handle)
createSnapshot()
.
Applications should not invoke this directly. Instead,
applications should use ADFc TaskFlows to declaratively work with
snapshots.
removeSnapshot
in interface DataControlFrame
handle
- public void beginTransaction(TransactionProperties properties)
beginTransaction
in interface DataControlFrame
properties
- the transaction properties.
Used by beginTransaction in BindingContextpublic void suspendTransaction()
suspendTransaction
in interface DataControlFrame
public void resumeTransaction()
resumeTransaction
in interface DataControlFrame
public java.lang.String getOpenTransactionName()
If the transaction policy of this frame is "existing", it returns the name of the transaction of the other frame specified in the datacontrol policy if that transaction is open.
A transaction is open and active if beginTransaction has been called but it has not been committed or rolled back.
getOpenTransactionName
in interface DataControlFrame
public boolean isTransactionOpen()
isTransactionOpen
in interface DataControlFrame
public boolean isTransactionDirty()
isTransactionDirty
in interface DataControlFrame
true
indicates unsaved data exists,false
indicates there is no unsaved data.public java.lang.String getName()
getName
in interface DataControlFrame
public void commit()
commit
in interface DataControlFrame
public void rollback()
rollback
in interface DataControlFrame
public java.lang.String findUniqueKey(java.lang.String key, java.util.Map dcMap)
DataControlFrame
findUniqueKey
in interface DataControlFrame
key
- key for the datacontroldcMap
- map of datacontrol from the BindingContext
public void removeDataControl(java.lang.Object key)
public void addDataControl(java.lang.Object key, DCDataControl dc)
key
- key for the datacontroldc
- A datacontrol to be added to the datacontrol frame.public DCDataControl findDataControl(java.lang.String dcName)
findDataControl
in interface DataControlFrame
dcName
- Name of the datacontrol
DataControlPolicy.getDataControl()
public DCDataControl findDataControl(java.lang.String dcName, boolean create)
public DCDataControl findDataControl(java.lang.String dcUsageName, java.lang.String dcName, boolean create)
public DataControlPolicy findPolicy(java.lang.String name)
findPolicy
in interface DataControlFrame
name
- Name of the datacontrol
public DataControlPolicy getDefaultPolicy()
getDefaultPolicy
in interface DataControlFrame
public boolean addDataControlPolicy(DataControlPolicy policy)
addDataControlPolicy
in interface DataControlFrame
policy
- The datacontrol policy to be added.
public boolean containsDataControl(java.lang.Object dc)
public DCBindingContainer getBindingContainer(java.lang.Object key)
getBindingContainer
in interface DataControlFrame
public DCBindingContainer putBindingContainer(java.lang.Object key, DCBindingContainer bc)
putBindingContainer
in interface DataControlFrame
public DCBindingContainer removeBindingContainer(java.lang.Object key)
removeBindingContainer
in interface DataControlFrame
public java.util.Collection<DCBindingContainer> getBindingContainers()
getBindingContainers
in interface DataControlFrame
public boolean containsBindingContainer(java.lang.Object bc)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |