com.filenet.api.constants
Class AreaDeleteMethod

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

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

Provides a set of constants that identify the method used to delete content from a file storage area, fixed storage area, or content cache area. If a fixed content device does not support one of the secure delete methods (that is, destructive or purge), then the device's standard delete method is used.

See Also:
Serialized Form

Field Summary
static AreaDeleteMethod DESTRUCTIVE
          Specifies that content be overwritten once with zeros before it's deleted.
static int DESTRUCTIVE_AS_INT
          An int value associated with the DESTRUCTIVE instance of this class.
static AreaDeleteMethod PURGE
          Specifies that content be overwritten three times before it's deleted.
static int PURGE_AS_INT
          An int value associated with the PURGE instance of this class.
static AreaDeleteMethod STANDARD
          Specifies that content be deleted using the normal delete operation for the given device or file system.
static int STANDARD_AS_INT
          An int value associated with the STANDARD instance of this class.
 
Method Summary
static AreaDeleteMethod 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

DESTRUCTIVE_AS_INT

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

DESTRUCTIVE

public static final AreaDeleteMethod DESTRUCTIVE
Specifies that content be overwritten once with zeros before it's deleted.


PURGE_AS_INT

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

PURGE

public static final AreaDeleteMethod PURGE
Specifies that content be overwritten three times before it's deleted. This is the most secure form of delete.


STANDARD_AS_INT

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

STANDARD

public static final AreaDeleteMethod STANDARD
Specifies that content be deleted using the normal delete operation for the given device or file system.

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 AreaDeleteMethod 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.