oracle.adf.model
Class BaseDataControlPolicyImpl

java.lang.Object
  oracle.adf.model.BaseDataControlPolicyImpl

All Implemented Interfaces:

DataControlPolicy

public class BaseDataControlPolicyImpl
extends java.lang.Object
implements DataControlPolicy

Since:

11.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.adf.model.DataControlPolicy

DataControlPolicy.ReleasePolicy

Field Summary

protected java.lang.String	mName
protected DataControlPolicy.ReleasePolicy	mReleasePolicy
protected java.lang.String	mTransactionPolicy

Fields inherited from interface oracle.adf.model.DataControlPolicy

TRANSACTION_POLICY_NEW, TRANSACTION_POLICY_NONE

Constructor Summary

BaseDataControlPolicyImpl(java.lang.String name, java.lang.String transactionPolicy, DataControlPolicy.ReleasePolicy releasePolicy)

Method Summary

DCDataControl	getDataControl() Returns the datacontrol instance for the datacontrol name specified in this policy.
java.lang.String	getName() Name of the datacontrol that this datacontrol policy applies to.
DataControlPolicy.ReleasePolicy	getReleasePolicy() This methods provides a hint to the datacontrol frame what should be done on this datacontrol when release is called on the frame.
java.lang.String	getTransactionPolicy() This methods provides a hint to the datacontrol frame what should be done on this datacontrol when transaction operations are called on the frame.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mName

protected java.lang.String mName

mTransactionPolicy

protected java.lang.String mTransactionPolicy

mReleasePolicy

protected DataControlPolicy.ReleasePolicy mReleasePolicy

Constructor Detail

BaseDataControlPolicyImpl

public BaseDataControlPolicyImpl(java.lang.String name,
                                 java.lang.String transactionPolicy,
                                 DataControlPolicy.ReleasePolicy releasePolicy)

Parameters:

name - Name of the policy. This should be the name of the datacontrol that this policy would apply to. For default policy, this can ben null.

transactionPolicy - the transaction policy for this datacontrol policy. See DataControlPolicy.getTransactionPolicy for valid values.

releasePolicy - the release policy for this datacontrol policy. See DataControlPolicy.getReleasePolicy for valid values.

Method Detail

getName

public java.lang.String getName()

Name of the datacontrol that this datacontrol policy applies to. This value is ignored and can be null if this policy is used as a default policy in a datacontrol frame.

Specified by:

getName in interface DataControlPolicy

Returns:

The name of the datacontrol that this datacontrol policy applies to.

getTransactionPolicy

public java.lang.String getTransactionPolicy()

This methods provides a hint to the datacontrol frame what should be done on this datacontrol when transaction operations are called on the frame.

Return values are:

TRANSACTION_POLICY_NEW

if the datacontrol participates in a transaction that is initiated in this datacontrol frame.

TRANSACTION_POLICY_NONE

if the datacontrol should not participate in any transaction. For example, if the datacontrol is being used in a task flow that does not use transaction.

Datacontrol frame name

if the datacontrol particpates in an existing transaction that is initiated in another datacontrol frame. For example, if a transaction is started from frameA, and this frame participates in that same transaction, getTransactionPolicy() should return "frameA".

Specified by:

getTransactionPolicy in interface DataControlPolicy

Returns:

The transaction policy for the datacontrol.

getReleasePolicy

public DataControlPolicy.ReleasePolicy getReleasePolicy()

This methods provides a hint to the datacontrol frame what should be done on this datacontrol when release is called on the frame.

Specified by:

getReleasePolicy in interface DataControlPolicy

Returns:

The release policy for the datacontrol.

getDataControl

public DCDataControl getDataControl()

Returns the datacontrol instance for the datacontrol name specified in this policy. Subclasses should override this method to return the datacontrol.

Specified by:

getDataControl in interface DataControlPolicy

Returns:

A Datacontrol instance with the datacontrol name specified in this policy; null if one cannot be found.