public abstract class SandboxStateInfo
extends java.lang.Object
SandboxRuntimeSupport
may support the use of this class for
examining the state of a sandbox before entering a sandbox.
Modifier | Constructor and Description |
---|---|
protected |
SandboxStateInfo(java.lang.String sandboxId)
Constructs an object with no extra information except the ID of the
sandbox.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getSandboxId()
Returns the ID of the sandbox of which the state is to be examined.
|
abstract SandboxState |
getSandboxState()
Returns the state of the sandbox.
|
abstract boolean |
isSandboxOpen()
Returns
true if the sandbox is open. |
abstract boolean |
isSandboxOperationInProgress()
Returns
true if an operation on the sandbox is in progress. |
abstract boolean |
isSandboxOperationScheduled()
Returns
true if an operation is scheduled to be performed on
the sandbox. |
abstract boolean |
isSandboxPublishInProgress()
Returns
true if the sandbox is being published. |
abstract boolean |
isSandboxPublishScheduled()
Returns
true if the sandbox is scheduled to be published. |
abstract boolean |
isSandboxRefreshInProgress()
Returns
true if the sandbox is being refreshed. |
abstract boolean |
isSandboxRefreshScheduled()
Returns
true if the sandbox is scheduled to be refreshed. |
protected SandboxStateInfo(java.lang.String sandboxId)
sandboxId
- the ID of the sandboxjava.lang.IllegalArgumentException
- if the given ID is nullpublic final java.lang.String getSandboxId()
public abstract SandboxState getSandboxState()
public abstract boolean isSandboxOpen()
true
if the sandbox is open. An open sandbox is not
published or being destroyed. Note that being "open" does not imply no
operation is scheduled or in progress. It simply means the contents of
the sandbox are available.true
if the sandbox is openpublic abstract boolean isSandboxOperationScheduled()
true
if an operation is scheduled to be performed on
the sandbox.true
if an operation is scheduled to be performed on
the sandboxpublic abstract boolean isSandboxOperationInProgress()
true
if an operation on the sandbox is in progress.true
if an operation on the sandbox is in progresspublic abstract boolean isSandboxRefreshScheduled()
true
if the sandbox is scheduled to be refreshed.true
if the sandbox is scheduled to be refreshedpublic abstract boolean isSandboxRefreshInProgress()
true
if the sandbox is being refreshed.true
if the sandbox is being refreshedpublic abstract boolean isSandboxPublishScheduled()
true
if the sandbox is scheduled to be published.true
if the sandbox is scheduled to be publishedpublic abstract boolean isSandboxPublishInProgress()
true
if the sandbox is being published.true
if the sandbox is being published