com.filenet.api.constants
Class PublishingStatus

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

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

Provides a set of constants that identify the status of a publish request.

See Also:
Serialized Form

Field Summary
static PublishingStatus PUBLISHING_COMPLETE
          Specifies that the request has been successfully processed.
static int PUBLISHING_COMPLETE_AS_INT
          An int value associated with the PUBLISHING_COMPLETE instance of this class.
static PublishingStatus PUBLISHING_DELETING
          Specifies that the request is pending deletion.
static int PUBLISHING_DELETING_AS_INT
          An int value associated with the PUBLISHING_DELETING instance of this class.
static PublishingStatus PUBLISHING_IN_ERROR
          Specifies that the request was unsuccessfully processed.
static int PUBLISHING_IN_ERROR_AS_INT
          An int value associated with the PUBLISHING_IN_ERROR instance of this class.
static PublishingStatus PUBLISHING_IN_QUEUE
          Specifies that the request has not yet been processed.
static int PUBLISHING_IN_QUEUE_AS_INT
          An int value associated with the PUBLISHING_IN_QUEUE instance of this class.
static PublishingStatus PUBLISHING_IN_WORK
          Specifies that the request is currently being processed.
static int PUBLISHING_IN_WORK_AS_INT
          An int value associated with the PUBLISHING_IN_WORK instance of this class.
 
Method Summary
static PublishingStatus 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

PUBLISHING_IN_ERROR_AS_INT

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

PUBLISHING_IN_ERROR

public static final PublishingStatus PUBLISHING_IN_ERROR
Specifies that the request was unsuccessfully processed.


PUBLISHING_IN_WORK_AS_INT

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

PUBLISHING_IN_WORK

public static final PublishingStatus PUBLISHING_IN_WORK
Specifies that the request is currently being processed.


PUBLISHING_DELETING_AS_INT

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

PUBLISHING_DELETING

public static final PublishingStatus PUBLISHING_DELETING
Specifies that the request is pending deletion.


PUBLISHING_COMPLETE_AS_INT

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

PUBLISHING_COMPLETE

public static final PublishingStatus PUBLISHING_COMPLETE
Specifies that the request has been successfully processed.


PUBLISHING_IN_QUEUE_AS_INT

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

PUBLISHING_IN_QUEUE

public static final PublishingStatus PUBLISHING_IN_QUEUE
Specifies that the request has not yet been processed.

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