com.filenet.api.constants
Class InstallationStatus

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

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

Provides a set of constants that identify the status of an add-on installation or upgrade.

See Also:
Serialized Form

Field Summary
static InstallationStatus INSTALLATION_FAILURE
          Specifies that the add-on installation or upgrade was not successful.
static int INSTALLATION_FAILURE_AS_INT
          An int value associated with the INSTALLATION_FAILURE instance of this class.
static InstallationStatus INSTALLED
          Specifies that the add-on installation or upgrade was successful.
static int INSTALLED_AS_INT
          An int value associated with the INSTALLED instance of this class.
 
Method Summary
static InstallationStatus 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

INSTALLED_AS_INT

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

INSTALLED

public static final InstallationStatus INSTALLED
Specifies that the add-on installation or upgrade was successful.


INSTALLATION_FAILURE_AS_INT

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

INSTALLATION_FAILURE

public static final InstallationStatus INSTALLATION_FAILURE
Specifies that the add-on installation or upgrade was not successful.

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