|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.constants.CacheStatus
public final class CacheStatus
Defines settings for enabling or disabling a cache area for active use.
Field Summary | |
---|---|
static CacheStatus |
CLEARING
Disables the cache area for active use, deletes all content from the cache, initializes the values for all cache statistical properties, and automatically resets the cache status to the previous setting ( OPEN
or CLOSED ). |
static int |
CLEARING_AS_INT
An int value associated with the CLEARING instance of this class. |
static CacheStatus |
CLOSED
Disables the cache area for active use. |
static int |
CLOSED_AS_INT
An int value associated with the CLOSED instance of this class. |
static CacheStatus |
OPEN
Enables the cache area for active use. |
static int |
OPEN_AS_INT
An int value associated with the OPEN instance of this class. |
Method Summary | |
---|---|
static CacheStatus |
getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value. |
int |
getValue()
Returns the internal integer value associated with a specific instance of this class. |
java.lang.String |
toString()
Returns a String representation of this enumeration instance. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int CLEARING_AS_INT
int
value associated with the CLEARING instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
public static final CacheStatus CLEARING
OPEN
or CLOSED
). Once started, this cache clearing operation always completes; you cannot stop
the operation or manually change the cache status from CLEARING to any other setting. In order for the
clearing operation to be performed and for the cache status not to remain set to CLEARING
indefinitely, at least one server must be associated with the same site as that of the content cache.
For information on associating a content cache with a site, see the
ContentCacheConfiguration interface.
public static final int CLOSED_AS_INT
int
value associated with the CLOSED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
public static final CacheStatus CLOSED
public static final int OPEN_AS_INT
int
value associated with the OPEN instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
public static final CacheStatus OPEN
Method Detail |
---|
public int getValue()
getInstanceFromInt(int)
public java.lang.String toString()
String
representation of this enumeration instance.
toString
in class java.lang.Object
public static CacheStatus getInstanceFromInt(int value)
value
- The integer value. (See the *_AS_INT fields.)
EngineRuntimeException
- If an enumeration instance with the given
ordinal value does not exist.getValue()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |