public interface SandboxInfoCache
Sandbox
implementation as having the
capability of caching some information upon the first access. Subsequent
access to the cached information will not cause the information to be
updated. Methods of Sandbox
class that support caching are
defined by this interface.
Without explicitly implementing this interface, a Sandbox
implementation is expected to return real-time information. For example,
every time getState() is invoked, the sandbox state at the time of the
invocation must be returned. When real-time information update is not
necessary, performance may be improved by retrieving the information once,
caching the information in case the same information is needed again. This
interface provides a means to identify a Sandbox
implementation
that supports information caching, and which methods.
Subclasses should never implement this interface without also extending
Sandbox
class. New methods from Sandbox
class may
be added to this interface in the future. In general, subclasses are
expected to extend the Sandbox
implementation that provides
real-time information and override the methods defined in this interface to
cache the results from the super class upon first access. Subsequent access
should return the cached information.
Modifier and Type | Method and Description |
---|---|
Sandbox |
asSandbox()
Returns this object as a
Sandbox object. |
SandboxConstraints |
getConstraints() |
java.lang.String |
getCreatedBy() |
java.util.Date |
getCreationDate() |
java.lang.String |
getDescription() |
java.lang.String |
getId() |
java.lang.String |
getName() |
java.util.Date |
getPublishDate() |
java.lang.String |
getPublishedBy() |
java.util.Date |
getRefreshDate() |
java.lang.String |
getRefreshedBy() |
SandboxState |
getState() |
java.util.Date |
getUpdateDate() |
java.lang.String |
getUpdatedBy() |
boolean |
isArchive() |
boolean |
isPrivate() |
boolean |
isPublishable() |
boolean |
isRefreshNeeded() |
boolean |
isRefreshRequired() |
boolean |
isVisualBuilderEnabled() |
Sandbox asSandbox()
Sandbox
object.Sandbox
objectjava.lang.String getId()
java.lang.String getName()
java.lang.String getDescription()
SandboxState getState()
java.util.Date getCreationDate()
java.lang.String getCreatedBy()
java.util.Date getUpdateDate()
java.lang.String getUpdatedBy()
java.util.Date getRefreshDate()
java.lang.String getRefreshedBy()
java.util.Date getPublishDate()
java.lang.String getPublishedBy()
SandboxConstraints getConstraints()
boolean isArchive()
boolean isPrivate()
boolean isPublishable()
boolean isRefreshRequired()
boolean isRefreshNeeded()
boolean isVisualBuilderEnabled()