com.filenet.api.constants
Class PublicationStatus

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

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

Provides a set of constants that identify the publication status of a document.

See Also:
Serialized Form

Field Summary
static PublicationStatus DOCUMENT_IS_DEPENDENT_PUBLICATION
          Specifies that a document is a publication that is dependent on its source (it will be deleted if the source document is deleted).
static int DOCUMENT_IS_DEPENDENT_PUBLICATION_AS_INT
          An int value associated with the DOCUMENT_IS_DEPENDENT_PUBLICATION instance of this class.
static PublicationStatus DOCUMENT_IS_INDEPENDENT_PUBLICATION
          Specifies that a document is a publication that is independent of its source (it won't be deleted if the source document is deleted).
static int DOCUMENT_IS_INDEPENDENT_PUBLICATION_AS_INT
          An int value associated with the DOCUMENT_IS_INDEPENDENT_PUBLICATION instance of this class.
static PublicationStatus DOCUMENT_IS_NOT_PUBLICATION
          Specifies that the document is not a publication.
static int DOCUMENT_IS_NOT_PUBLICATION_AS_INT
          An int value associated with the DOCUMENT_IS_NOT_PUBLICATION instance of this class.
 
Method Summary
static PublicationStatus 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

DOCUMENT_IS_DEPENDENT_PUBLICATION_AS_INT

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

DOCUMENT_IS_DEPENDENT_PUBLICATION

public static final PublicationStatus DOCUMENT_IS_DEPENDENT_PUBLICATION
Specifies that a document is a publication that is dependent on its source (it will be deleted if the source document is deleted).


DOCUMENT_IS_INDEPENDENT_PUBLICATION_AS_INT

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

DOCUMENT_IS_INDEPENDENT_PUBLICATION

public static final PublicationStatus DOCUMENT_IS_INDEPENDENT_PUBLICATION
Specifies that a document is a publication that is independent of its source (it won't be deleted if the source document is deleted).


DOCUMENT_IS_NOT_PUBLICATION_AS_INT

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

DOCUMENT_IS_NOT_PUBLICATION

public static final PublicationStatus DOCUMENT_IS_NOT_PUBLICATION
Specifies that the document is not a publication.

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