com.filenet.api.constants
Class CacheStatus

java.lang.Object
  extended by com.filenet.api.constants.CacheStatus
All Implemented Interfaces:
java.io.Serializable

public final class CacheStatus
extends java.lang.Object
implements java.io.Serializable

Defines settings for enabling or disabling a cache area for active use.

See Also:
Serialized Form

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

CLEARING_AS_INT

public static final int CLEARING_AS_INT
An 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.

See Also:
Constant Field Values

CLEARING

public static final 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). 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.


CLOSED_AS_INT

public static final int CLOSED_AS_INT
An 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.

See Also:
Constant Field Values

CLOSED

public static final CacheStatus CLOSED
Disables the cache area for active use.


OPEN_AS_INT

public static final int OPEN_AS_INT
An 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.

See Also:
Constant Field Values

OPEN

public static final CacheStatus OPEN
Enables the cache area for active use.

Method Detail

getValue

public int getValue()
Returns the internal integer value associated with a specific instance of this class.

Returns:
The enumeration instance's ordinal value.
See Also:
getInstanceFromInt(int)

toString

public java.lang.String toString()
Returns a String representation of this enumeration instance.

Overrides:
toString in class java.lang.Object
Returns:
The enumeration instance's description.

getInstanceFromInt

public static CacheStatus getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.

Parameters:
value - The integer value. (See the *_AS_INT fields.)
Returns:
The enumeration instance with the given ordinal value.
Throws:
EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
See Also:
getValue()


© Copyright IBM Corporation 2006, 2009. All rights reserved.