Skip navigation links

oracle.adf.share.mds
Class ADFSessionOptions

java.lang.Object
oracle.adf.share.mds.ADFSessionOptions

All Implemented Interfaces:

java.io.Serializable

public class ADFSessionOptions

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

static class

ADFSessionOptions.Mode Certain methods are prohibited in ADFSessionOptions based on the the current Mode.

Field Summary

static int	CLEVEL_CHECK_AND_CHANGE
static int	CLEVEL_CHECK_ONLY
static int	CLEVEL_CHECK_ONLY_INCL_WARNINGS
static int	CLEVEL_FORCED
static int	CLEVEL_NO_CHECK
static int	ERR_HANDLE_COLLECT_ALL_ERRS
static int	ERR_HANDLE_RETURN_ON_FIRST_ERR
static java.lang.String	LABEL_LATEST
static java.lang.String	LABEL_MATCH
static java.lang.String	LABEL_NONE
static java.lang.String	LABEL_NOT_FOUND
static java.lang.String	MDS_SANDBOX_METADATA_CUST_CLASS_NAME_KEY
static java.lang.String	MDS_SANDBOX_METADATA_CUST_CLASS_VALUE_KEY
static java.lang.String	PName_authoringSettings
static java.lang.String	PName_baseLabel
static java.lang.String	PName_canChangeCheck
static java.lang.String	PName_custclasses
static java.lang.String	PName_custPolicy
static java.lang.String	PName_includeTipMDSSession
static java.lang.String	PName_isolationLevel
static java.lang.String	PName_label
static java.lang.String	PName_mdslabel
static java.lang.String	PName_sboxname
static java.lang.String	PName_skipCheck

Constructor Summary

ADFSessionOptions()

ADFSessionOptions(ADFSessionOptions org)

Method Summary

static boolean	addChangeListener(ADFSessOptsChangeListener listener)
void	checkSessionOptionsChange(int coercionLevel)
java.lang.String	computeLabel(java.lang.String labelName)
static java.lang.Object	findLabels(java.lang.String matchString, boolean firstMatch, boolean latest)
void	finishSessionOptionsChange(int coercionLevel)
static ADFSessionOptions	fromString(java.lang.String str)
ADFAuthoringSettings	getAuthoringSettings()
java.lang.String	getBaseLabel()
oracle.mds.cust.CustClassList	getCustClassList()
oracle.mds.config.CustConfig	getCustConfig()
oracle.mds.cust.CustomizationPolicy	getCustomizationPolicy() Get the CustomizationPolicy object associated with the ADFSessionOptions instance.
int	getEditRevNumber()
int	getErrorHandlingMode()
oracle.mds.core.IsolationLevel	getIsolationLevel()
static oracle.mds.core.IsolationLevel	getIsolationLevelValue(java.lang.String s)
java.lang.String	getLabel()
static oracle.mds.config.CustConfig	getMDSCustConfig()
java.lang.Object	getMergeConflictResolver()
ADFSessionOptions.Mode	getMode() Get the current Mode on ADFSessionOptions.
java.lang.String	getSandboxName()
java.lang.String	getTrimCustClassListToClass()
java.lang.String	getTrimCustClassListToValue() Deprecated. in 12.2.2 - ADFSessionOptions no longer keeps track of this attribute
boolean	includeTipMDSSession()
boolean	isCurrent()
boolean	isSkipCheck()
boolean	isSkipSetIfUnchanged()
static ADFSessionOptions	loadFromXML(org.w3c.dom.Element el)
void	readXMLConfig(org.w3c.dom.Element el)
static boolean	removeChangeListener(ADFSessOptsChangeListener listener)
static void	resetChangeListeners()
boolean	resetCustClassList(int coercionLevel) Resets the CustomizationClass list (effects take place in session scope).
boolean	setAuthoringSettings(ADFAuthoringSettings settings, int coercionLevel)
boolean	setBaseLabel(java.lang.String baseLabel, int coercionLevel)
boolean	setCustomizationPolicy(oracle.mds.cust.CustomizationPolicy custPolicy, int coercionLevel) Set the CustomizationPolicy for the ADFSessionOptions instance
boolean	setErrorHandlingMode(int m)
boolean	setIncludeTipMDSSession(boolean b, int coercionLevel)
boolean	setIsolationLevel(oracle.mds.core.IsolationLevel iLevel, int coercionLevel)
java.lang.Object	setMergeConflictResolver(java.lang.Object resolver)
boolean	setMode(ADFSessionOptions.Mode mode, int coercionLevel) Sets the Mode.
boolean	setParam(java.lang.String paramName, java.lang.Object paramValue, int coercionLevel)
boolean	setParams(java.util.List<java.lang.String> paramNames, java.util.List<java.lang.Object> paramValues, int coercionLevel)
boolean	setSandboxName(java.lang.String sandboxName, int coercionLevel) Deprecated. in 12.2.2 - Please use setSandboxSettings(SandboxSettings,int) or unsetSandboxSettings(int) instead.
boolean	setSandboxSettings(SandboxSettings sandboxSettings, int coercionLevel) Sets up ADFSessionOptions for a Sandbox environment.
boolean	setSkipCheck(boolean b, int coercionLevel)
boolean	setSkipSetIfUnchanged(boolean b, int coercionLevel)
boolean	setTrimCustClasses(java.lang.String custClasses, int coercionLevel)
boolean	setValuesFrom(ADFSessionOptions fromSO, int coercionLevel)
boolean	testSetParams(java.util.List<java.lang.String> paramNames, java.util.List<java.lang.Object> paramValues) Tests if setting the specified parameters will result in a change of the current ADFSessionOptions.
java.io.ByteArrayOutputStream	toByteArray()
boolean	trimCustClassListTo(java.lang.String custClassName, int coercionLevel) Trims CustomizationClass list to the specified custClassName in ADFSessionOptions (effects take place in session scope)
boolean	trimCustClassListTo(java.lang.String custClassName, java.lang.String custClassValue, int coercionLevel) Deprecated. in 12.2.2 - This method will ignore the custClassValue parameter; Use trimCustClassListTo(String, int).
boolean	unsetSandboxSettings(int coercionLevel) Resets ADFSessionOptions values to reflect an environment without a sandbox.
void	verifyCurrentMDSSession() Compares the settings in the current MDSSession against this ADFSessionOptions.
static boolean	verifyLabel(java.lang.String newLabel)
org.w3c.dom.Element	writeXMLConfig(oracle.xml.parser.v2.XMLDocument doc, org.w3c.dom.Element elemParent)

Methods inherited from class java.lang.Object

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

Field Detail

CLEVEL_NO_CHECK

public static final int CLEVEL_NO_CHECK

See Also:

Constant Field Values

CLEVEL_FORCED

public static final int CLEVEL_FORCED

See Also:

Constant Field Values

CLEVEL_CHECK_AND_CHANGE

public static final int CLEVEL_CHECK_AND_CHANGE

See Also:

Constant Field Values

CLEVEL_CHECK_ONLY

public static final int CLEVEL_CHECK_ONLY

See Also:

Constant Field Values

CLEVEL_CHECK_ONLY_INCL_WARNINGS

public static final int CLEVEL_CHECK_ONLY_INCL_WARNINGS

See Also:

Constant Field Values

PName_sboxname

public static final java.lang.String PName_sboxname

See Also:

Constant Field Values

PName_baseLabel

public static final java.lang.String PName_baseLabel

See Also:

Constant Field Values

PName_label

public static final java.lang.String PName_label

See Also:

Constant Field Values

PName_mdslabel

public static final java.lang.String PName_mdslabel

See Also:

Constant Field Values

PName_includeTipMDSSession

public static final java.lang.String PName_includeTipMDSSession

See Also:

Constant Field Values

PName_isolationLevel

public static final java.lang.String PName_isolationLevel

See Also:

Constant Field Values

PName_skipCheck

public static final java.lang.String PName_skipCheck

See Also:

Constant Field Values

PName_canChangeCheck

public static final java.lang.String PName_canChangeCheck

See Also:

Constant Field Values

PName_custclasses

public static final java.lang.String PName_custclasses

See Also:

Constant Field Values

PName_authoringSettings

public static final java.lang.String PName_authoringSettings

See Also:

Constant Field Values

PName_custPolicy

public static final java.lang.String PName_custPolicy

See Also:

Constant Field Values

LABEL_LATEST

public static final java.lang.String LABEL_LATEST

See Also:

Constant Field Values

LABEL_MATCH

public static final java.lang.String LABEL_MATCH

See Also:

Constant Field Values

LABEL_NONE

public static final java.lang.String LABEL_NONE

See Also:

Constant Field Values

LABEL_NOT_FOUND

public static final java.lang.String LABEL_NOT_FOUND

See Also:

Constant Field Values

MDS_SANDBOX_METADATA_CUST_CLASS_NAME_KEY

public static final java.lang.String MDS_SANDBOX_METADATA_CUST_CLASS_NAME_KEY

See Also:

Constant Field Values

MDS_SANDBOX_METADATA_CUST_CLASS_VALUE_KEY

public static final java.lang.String MDS_SANDBOX_METADATA_CUST_CLASS_VALUE_KEY

See Also:

Constant Field Values

ERR_HANDLE_RETURN_ON_FIRST_ERR

public static final int ERR_HANDLE_RETURN_ON_FIRST_ERR

See Also:

Constant Field Values

ERR_HANDLE_COLLECT_ALL_ERRS

public static final int ERR_HANDLE_COLLECT_ALL_ERRS

See Also:

Constant Field Values

Constructor Detail

ADFSessionOptions

public ADFSessionOptions()

ADFSessionOptions

public ADFSessionOptions(ADFSessionOptions org)

Method Detail

getEditRevNumber

public int getEditRevNumber()

getErrorHandlingMode

public int getErrorHandlingMode()

setErrorHandlingMode

public boolean setErrorHandlingMode(int m)

getMergeConflictResolver

public java.lang.Object getMergeConflictResolver()

setMergeConflictResolver

public java.lang.Object setMergeConflictResolver(java.lang.Object resolver)

addChangeListener

public static boolean addChangeListener(ADFSessOptsChangeListener listener)

removeChangeListener

public static boolean removeChangeListener(ADFSessOptsChangeListener listener)

resetChangeListeners

public static void resetChangeListeners()

setValuesFrom

public boolean setValuesFrom(ADFSessionOptions fromSO,
                             int coercionLevel)

getSandboxName

public java.lang.String getSandboxName()

checkSessionOptionsChange

public void checkSessionOptionsChange(int coercionLevel)

finishSessionOptionsChange

public void finishSessionOptionsChange(int coercionLevel)

isCurrent

public boolean isCurrent()

getMode

public ADFSessionOptions.Mode getMode()

Get the current Mode on ADFSessionOptions. Please see ADFSessionOptions.Mode for more details.

Returns:

The current Mode for this ADFSessionOptions instance.

setMode

public boolean setMode(ADFSessionOptions.Mode mode,
                       int coercionLevel)

Sets the Mode. Please see ADFSessionOptions.Mode for more details.

Parameters:

mode - specific Mode to set;

coercionLevel - int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).

Returns:

true if the change was made; false, otherwise.

setSandboxSettings

public boolean setSandboxSettings(SandboxSettings sandboxSettings,
                                  int coercionLevel)

Sets up ADFSessionOptions for a Sandbox environment.

Parameters:

sandboxSettings - contains the Sandbox Settings to copy over to ADFSessionOptions

coercionLevel - int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).

Returns:

true if the sandbox settings were set; false, otherwise.

See Also:

unsetSandboxSettings(int)

unsetSandboxSettings

public boolean unsetSandboxSettings(int coercionLevel)

Resets ADFSessionOptions values to reflect an environment without a sandbox.

Parameters:

coercionLevel - int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).

Returns:

true if the changes were successful; false, otherwise.

See Also:

setSandboxSettings(SandboxSettings,int)

setSandboxName

@Deprecated
public boolean setSandboxName(java.lang.String sandboxName,
                                         int coercionLevel)

Deprecated. in 12.2.2 - Please use setSandboxSettings(SandboxSettings,int) or unsetSandboxSettings(int) instead.

Tries to set the SandboxName.

Parameters:

sandboxName - String representing the sandbox name - must be the name of a valid sandbox.

coercionLevel - int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHA NGE).

Returns:

true if sandbox name was set; false, otherwise;

getLabel

public java.lang.String getLabel()

findLabels

public static java.lang.Object findLabels(java.lang.String matchString,
                                          boolean firstMatch,
                                          boolean latest)

computeLabel

public java.lang.String computeLabel(java.lang.String labelName)

getBaseLabel

public java.lang.String getBaseLabel()

verifyLabel

public static boolean verifyLabel(java.lang.String newLabel)

setBaseLabel

public boolean setBaseLabel(java.lang.String baseLabel,
                            int coercionLevel)

includeTipMDSSession

public boolean includeTipMDSSession()

setIncludeTipMDSSession

public boolean setIncludeTipMDSSession(boolean b,
                                       int coercionLevel)

getIsolationLevel

public oracle.mds.core.IsolationLevel getIsolationLevel()

setIsolationLevel

public boolean setIsolationLevel(oracle.mds.core.IsolationLevel iLevel,
                                 int coercionLevel)

getIsolationLevelValue

public static oracle.mds.core.IsolationLevel getIsolationLevelValue(java.lang.String s)

isSkipCheck

public boolean isSkipCheck()

setSkipCheck

public boolean setSkipCheck(boolean b,
                            int coercionLevel)

isSkipSetIfUnchanged

public boolean isSkipSetIfUnchanged()

setSkipSetIfUnchanged

public boolean setSkipSetIfUnchanged(boolean b,
                                     int coercionLevel)

getMDSCustConfig

public static oracle.mds.config.CustConfig getMDSCustConfig()

getCustClassList

public oracle.mds.cust.CustClassList getCustClassList()

getCustConfig

public oracle.mds.config.CustConfig getCustConfig()

getCustomizationPolicy

public oracle.mds.cust.CustomizationPolicy getCustomizationPolicy()

Get the CustomizationPolicy object associated with the ADFSessionOptions instance. Should never return null.

Returns:

CustomizationPolicy - current CustomizationPolicy

setCustomizationPolicy

public boolean setCustomizationPolicy(oracle.mds.cust.CustomizationPolicy custPolicy,
                                      int coercionLevel)

Set the CustomizationPolicy for the ADFSessionOptions instance

Parameters:

custPolicy - - CustomizationPolicy object to set

coercionLevel - - int (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE)

Returns:

true if the change was applied; false, otherwise

getTrimCustClassListToClass

public java.lang.String getTrimCustClassListToClass()

getTrimCustClassListToValue

@Deprecated
public java.lang.String getTrimCustClassListToValue()

Deprecated. in 12.2.2 - ADFSessionOptions no longer keeps track of this attribute

Returns:

null

setTrimCustClasses

public boolean setTrimCustClasses(java.lang.String custClasses,
                                  int coercionLevel)

resetCustClassList

public boolean resetCustClassList(int coercionLevel)

Resets the CustomizationClass list (effects take place in session scope).

Parameters:

coercionLevel - int representing whether to force this change or not (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE)

Returns:

true if the change was applied; false, otherwise.

trimCustClassListTo

@Deprecated
public boolean trimCustClassListTo(java.lang.String custClassName,
                                              java.lang.String custClassValue,
                                              int coercionLevel)

Deprecated. in 12.2.2 - This method will ignore the custClassValue parameter; Use trimCustClassListTo(String, int).

Trims CustomizationClass list to the specified custClassName

Parameters:

custClassName - String representing full class name of the CustomizationClass;

custClassValue - currently ignored, see deprecated warning;

coercionLevel - int representing whether to force this change or not (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).

Returns:

true if the change was applied; false, otherwise.

trimCustClassListTo

public boolean trimCustClassListTo(java.lang.String custClassName,
                                   int coercionLevel)

Trims CustomizationClass list to the specified custClassName in ADFSessionOptions (effects take place in session scope)

Parameters:

custClassName - String representing full class name of the CustomizationClass

coercionLevel - int representing whether to force this change or not (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE)

Returns:

true if the change was applied; false, otherwise

getAuthoringSettings

public ADFAuthoringSettings getAuthoringSettings()

setAuthoringSettings

public boolean setAuthoringSettings(ADFAuthoringSettings settings,
                                    int coercionLevel)

setParams

public boolean setParams(java.util.List<java.lang.String> paramNames,
                         java.util.List<java.lang.Object> paramValues,
                         int coercionLevel)

setParam

public boolean setParam(java.lang.String paramName,
                        java.lang.Object paramValue,
                        int coercionLevel)

loadFromXML

public static ADFSessionOptions loadFromXML(org.w3c.dom.Element el)

readXMLConfig

public void readXMLConfig(org.w3c.dom.Element el)

writeXMLConfig

public org.w3c.dom.Element writeXMLConfig(oracle.xml.parser.v2.XMLDocument doc,
                                          org.w3c.dom.Element elemParent)

fromString

public static ADFSessionOptions fromString(java.lang.String str)

toByteArray

public java.io.ByteArrayOutputStream toByteArray()

testSetParams

public boolean testSetParams(java.util.List<java.lang.String> paramNames,
                             java.util.List<java.lang.Object> paramValues)

Tests if setting the specified parameters will result in a change of the current ADFSessionOptions. Note that this is different from calling setParams(List, List, int) with CLEVEL_CHECK_ONLY, which invokes the listeners and returns false at the end because no changes are made.

Parameters:

paramNames - a list of parameter names

paramValues - a list of corresponding parameter values

Returns:

true if the given parameters are different than the settings in this ADFSessionOptions, false if they are the same.

verifyCurrentMDSSession

public void verifyCurrentMDSSession()

Compares the settings in the current MDSSession against this ADFSessionOptions.

Throws:

ADFShareException - if the sandbox, label, or trim CC name does not match.

Skip navigation links