com.filenet.api.constants
Class CachedContentOption

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

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

Defines settings for determining when or if a content cache can be utilized for a particular storage area.

See Also:
Serialized Form

Field Summary
static CachedContentOption ALLOWED
          Allows content for this storage area to be copied to a content cache.
static int ALLOWED_AS_INT
          An int value associated with the ALLOWED instance of this class.
static CachedContentOption CROSS_SITE_ONLY
          Allows content for this storage area to be copied to a content cache provided that the server and the storage area do not belong to the same site.
static int CROSS_SITE_ONLY_AS_INT
          An int value associated with the CROSS_SITE_ONLY instance of this class.
static CachedContentOption NOT_ALLOWED
          Disallows content for this storage area to be copied to a content cache.
static int NOT_ALLOWED_AS_INT
          An int value associated with the NOT_ALLOWED instance of this class.
 
Method Summary
static CachedContentOption 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

NOT_ALLOWED_AS_INT

public static final int NOT_ALLOWED_AS_INT
An int value associated with the NOT_ALLOWED 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

NOT_ALLOWED

public static final CachedContentOption NOT_ALLOWED
Disallows content for this storage area to be copied to a content cache.


ALLOWED_AS_INT

public static final int ALLOWED_AS_INT
An int value associated with the ALLOWED 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

ALLOWED

public static final CachedContentOption ALLOWED
Allows content for this storage area to be copied to a content cache.


CROSS_SITE_ONLY_AS_INT

public static final int CROSS_SITE_ONLY_AS_INT
An int value associated with the CROSS_SITE_ONLY 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

CROSS_SITE_ONLY

public static final CachedContentOption CROSS_SITE_ONLY
Allows content for this storage area to be copied to a content cache provided that the server and the storage area do not belong to the same site.

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 CachedContentOption 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, 2008. All rights reserved.