oracle.adf.share.sandbox

Class SandboxConstraints

java.lang.Object

oracle.adf.share.sandbox.SandboxConstraints

public class SandboxConstraints
extends java.lang.Object

Conditions that describe how the content of a sandbox is restricted.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SandboxConstraints.ContentLevel A two-part key that identifies a data set of sandbox content.
static class	SandboxConstraints.ContentLevelType Types of content levels.

Field Summary

Fields

Modifier and Type	Field and Description
static SandboxConstraints	ANY_WORKSPACE A constraint that limits the workspace level to ContentLevel.ANY.
static SandboxConstraints	PROGRAMMATIC_WORKSPACE A constraint that limits the workspace level to ContentLevel.PROGRAMMATIC.
static SandboxConstraints	SITE_WORKSPACE A constraint that limits the workspace level to ContentLevel.SITE.
static SandboxConstraints	VERTICAL_WORKSPACE A constraint that limits the workspace level to ContentLevel.VERTICAL.

Constructor Summary

Constructors

Constructor and Description
SandboxConstraints(SandboxConstraints.ContentLevel workspaceLevel) Constructs a SandboxConstraints by specifying the level of the content a sandbox contains.
SandboxConstraints(SandboxConstraints.ContentLevel workspaceLevel, java.util.List<SandboxConstraints.ContentLevel> dependentLevels) Constructs a SandboxConstraints by specifying the level of the content a sandbox contains, and optionally a list of levels the sandbox content depends on.
SandboxConstraints(SandboxConstraints.ContentLevel workspaceLevel, java.util.List<SandboxConstraints.ContentLevel> dependentLevels, java.util.Map<java.lang.String,java.lang.String> attrs) Constructs a SandboxConstraints by specifying the level of the content a sandbox contains, a list of levels the sandbox content depends on and a collection of attributes.

Method Summary

Modifier and Type	Method and Description
static SandboxConstraints	fromXml(java.lang.String xml) Constructs a SandboxConstraints object from its XML representation.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns additional attributes if any.
java.util.List<SandboxConstraints.ContentLevel>	getDependentLevels() Returns the list of the levels the content of a sandbox depends on.
SandboxConstraints.ContentLevel	getWorkspaceLevel() Returns the level of the content of a sandbox.
static boolean	isWorkspaceProgrammatic(SandboxConstraints sc) Returns true if getWorkspaceLevel() of a SandboxConstraints object returns a content level of type >ContentLevelType.PROGRAMMATIC.
java.lang.String	toString()
java.lang.String	toXml() Returns an XML representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

SITE_WORKSPACE

public static final SandboxConstraints SITE_WORKSPACE

A constraint that limits the workspace level to ContentLevel.SITE.

VERTICAL_WORKSPACE

public static final SandboxConstraints VERTICAL_WORKSPACE

A constraint that limits the workspace level to ContentLevel.VERTICAL.

ANY_WORKSPACE

public static final SandboxConstraints ANY_WORKSPACE

A constraint that limits the workspace level to ContentLevel.ANY.

PROGRAMMATIC_WORKSPACE

public static final SandboxConstraints PROGRAMMATIC_WORKSPACE

A constraint that limits the workspace level to ContentLevel.PROGRAMMATIC.

Constructor Detail

SandboxConstraints

public SandboxConstraints(SandboxConstraints.ContentLevel workspaceLevel)

Constructs a SandboxConstraints by specifying the level of the content a sandbox contains.

Parameters:

workspaceLevel - the level of the content a sandbox contains

Throws:

java.lang.IllegalArgumentException - if the given level is null

SandboxConstraints

public SandboxConstraints(SandboxConstraints.ContentLevel workspaceLevel,
                          java.util.List<SandboxConstraints.ContentLevel> dependentLevels)

Constructs a SandboxConstraints by specifying the level of the content a sandbox contains, and optionally a list of levels the sandbox content depends on.

Parameters:

workspaceLevel - the level of the content a sandbox contains

dependentLevels - the list of levels the sandbox content depends on; null or an empty list if there is no dependency

SandboxConstraints

public SandboxConstraints(SandboxConstraints.ContentLevel workspaceLevel,
                          java.util.List<SandboxConstraints.ContentLevel> dependentLevels,
                          java.util.Map<java.lang.String,java.lang.String> attrs)

Constructs a SandboxConstraints by specifying the level of the content a sandbox contains, a list of levels the sandbox content depends on and a collection of attributes.

Parameters:

workspaceLevel - the level of the content a sandbox contains

dependentLevels - the list of levels the sandbox content depends on; null or an empty list if there is no dependency

attrs - the collection of attributes; null if there is no additional attributes

Method Detail

isWorkspaceProgrammatic

public static boolean isWorkspaceProgrammatic(SandboxConstraints sc)

Returns true if getWorkspaceLevel() of a SandboxConstraints object returns a content level of type >ContentLevelType.PROGRAMMATIC.

Parameters:

sc - a SandboxConstraints object or null

Returns:

true if getWorkspaceLevel() of the SandboxConstraints object returns a content level of type ContentLevelType.PROGRAMMATIC; false otherwise or if the given object is null

getDependentLevels

public final java.util.List<SandboxConstraints.ContentLevel> getDependentLevels()

Returns the list of the levels the content of a sandbox depends on.

Returns:

the list of the levels the content of a sandbox depends on; an empty list if there is no dependency. This method never returns null.

getWorkspaceLevel

public final SandboxConstraints.ContentLevel getWorkspaceLevel()

Returns the level of the content of a sandbox.

Returns:

the level of the content of a sandbox, which is never null

getAttributes

public final java.util.Map<java.lang.String,java.lang.String> getAttributes()

Returns additional attributes if any.

Returns:

the collection of additional attributes; an empty map if there is no additional attributes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXml

public java.lang.String toXml()

Returns an XML representation of this object.

Returns:

the XML representation of this object

fromXml

public static SandboxConstraints fromXml(java.lang.String xml)

Constructs a SandboxConstraints object from its XML representation.

Parameters:

xml - the XML representation of the SandboxConstraints object

Returns:

the SandboxConstraints object the given XML string represents; null if the given XML is not a representation of a SandboxConstraints object

Throws:

java.lang.IllegalArgumentException - if the given XML string is null