com.filenet.api.constants
Class AddOnType

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

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

Provides a set of constants that identify whether the installation of an add-on is optional or recommended.

See Also:
Serialized Form

Field Summary
static AddOnType OPTIONAL
          Specifies that the installation of an add-on is optional.
static int OPTIONAL_AS_INT
          An int value associated with the OPTIONAL instance of this class.
static AddOnType RECOMMENDED
          Specifies that the installation of an add-on is recommended.
static int RECOMMENDED_AS_INT
          An int value associated with the RECOMMENDED instance of this class.
 
Method Summary
static AddOnType 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

OPTIONAL_AS_INT

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

OPTIONAL

public static final AddOnType OPTIONAL
Specifies that the installation of an add-on is optional.


RECOMMENDED_AS_INT

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

RECOMMENDED

public static final AddOnType RECOMMENDED
Specifies that the installation of an add-on is recommended.

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