oracle.apps.fnd.applcore.sandbox.utils
Class SandboxUtils

java.lang.Object
  oracle.apps.fnd.applcore.sandbox.utils.SandboxUtils

public class SandboxUtils
extends java.lang.Object

Constructor Summary

SandboxUtils()

Method Summary

static void	activate(java.lang.String sandboxName) Activates a sandbox in the current session.
static void	activate(java.lang.String sandboxName, java.lang.String creationLabel) Deprecated.
static java.util.ArrayList<java.lang.String>	checkSandboxForAppsMenu(java.lang.String sbName)
static void	deactivate(java.lang.String sandboxName) Deactivate the currently active sandbox.
static java.lang.String	getCreationLabel(java.lang.String sandboxName) Gets a new creation label.
static java.lang.String	getMainLabelForImport() Gets a main line for importing a sandbox.
static java.lang.String	getPostMergeLabel(java.lang.String sandboxName) Gets a new post-merge label.
static java.lang.String	getPreMergeLabel(java.lang.String sandboxName) Gets a new pre-merge label.
static java.lang.String	getSandboxCreateErrorMessage(java.lang.String sandboxName)
static java.lang.String	getSandboxIfAvailable(java.lang.String profileValue)
static java.lang.String	getSandboxNamePrefix() Gets the prefix for ApplCore sandboxes based on the current session.
static boolean	isActive(java.lang.String sandboxName) Checks whether a sandbox is active in the current session.
static boolean	isActiveSandboxImported(java.lang.String activeSB, java.lang.String importCreationLabel)
static boolean	isApplCoreSandboxName(java.lang.String name) Returns true if a sandbox name implies that it is an ApplCore sandbox.
static boolean	isSandboxAvailable(java.lang.String sandboxName)
static boolean	isSandboxDSEnabled(java.lang.String profileValue)
static boolean	isSandboxPublished(java.lang.String sandboxName)

Methods inherited from class java.lang.Object

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

Constructor Detail

SandboxUtils

public SandboxUtils()

Method Detail

getSandboxIfAvailable

public static java.lang.String getSandboxIfAvailable(java.lang.String profileValue)

isSandboxAvailable

public static boolean isSandboxAvailable(java.lang.String sandboxName)

getSandboxCreateErrorMessage

public static java.lang.String getSandboxCreateErrorMessage(java.lang.String sandboxName)

isSandboxDSEnabled

public static boolean isSandboxDSEnabled(java.lang.String profileValue)

isSandboxPublished

public static final boolean isSandboxPublished(java.lang.String sandboxName)

getSandboxNamePrefix

public static final java.lang.String getSandboxNamePrefix()

Gets the prefix for ApplCore sandboxes based on the current session. If the session indicates that the environment is multi-tenant enabled, the enterprise ID will be part of the prefix

Returns:

the prefix for ApplCore sandboxes

isApplCoreSandboxName

public static final boolean isApplCoreSandboxName(java.lang.String name)

Returns true if a sandbox name implies that it is an ApplCore sandbox.

Parameters:

name - the name of the sandbox

Returns:

true if the sandbox is an ApplCore sandbox

Throws:

java.lang.NullPointerException - if the given name is null

getCreationLabel

public static java.lang.String getCreationLabel(java.lang.String sandboxName)

Gets a new creation label.

Parameters:

sandboxName - the sandbox name

Returns:

the creation label

Throws:

java.lang.IllegalArgumentException - if the sandbox name is null

getPreMergeLabel

public static java.lang.String getPreMergeLabel(java.lang.String sandboxName)

Gets a new pre-merge label.

Parameters:

sandboxName - the sandbox name

Returns:

the pre-merge label

Throws:

java.lang.IllegalArgumentException - if the sandbox name is null

getPostMergeLabel

public static java.lang.String getPostMergeLabel(java.lang.String sandboxName)

Gets a new post-merge label.

Parameters:

sandboxName - the sandbox name

Returns:

the post-merge label

Throws:

java.lang.IllegalArgumentException - if the sandbox name is null

activate

public static void activate(java.lang.String sandboxName,
                            java.lang.String creationLabel)

Deprecated.

Activates a sandbox in the current session.

Parameters:

sandboxName - the name of the sandbox

creationLabel - the creation label. The creation label must be a label obtained through getCreationLabel

Throws:

java.lang.IllegalArgumentException - if the given sandbox name is null

java.lang.NullPointerException - if the given creation label is null

See Also:

getCreationLabel(java.lang.String)

activate

public static void activate(java.lang.String sandboxName)

Activates a sandbox in the current session.

Parameters:

sandboxName - the name of the sandbox

Throws:

java.lang.IllegalArgumentException - if the given sandbox name is null

java.lang.NullPointerException - if the given creation label is null

isActive

public static boolean isActive(java.lang.String sandboxName)

Checks whether a sandbox is active in the current session.

Parameters:

sandboxName - the name of the sandbox

Returns:

true if the given sandbox is active in the current session

deactivate

public static void deactivate(java.lang.String sandboxName)

Deactivate the currently active sandbox.

Parameters:

sandboxName - the name of the sandbox

getMainLabelForImport

public static java.lang.String getMainLabelForImport()

Gets a main line for importing a sandbox.

Returns:

the post-merge label

Throws:

java.lang.IllegalArgumentException - if the sandbox name is null

isActiveSandboxImported

public static boolean isActiveSandboxImported(java.lang.String activeSB,
                                              java.lang.String importCreationLabel)

checkSandboxForAppsMenu

public static java.util.ArrayList<java.lang.String> checkSandboxForAppsMenu(java.lang.String sbName)

Parameters:

sbName - Sandbox name whose contents are to be checked for applications menu documents

Returns:

ArrayList of document names which are customized as part of the sandbox This API is strictly for Applcore internal usage only.