Content Engine Java API: PropertyState

java.lang.Object
- com.filenet.api.constants.PropertyState

All Implemented Interfaces:

java.io.Serializable
```
public class PropertyState
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that indicates the type of value held by a Property object as it relates to a given Content Engine property.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static PropertyState`	`NO_VALUE` Indicates that the Content Engine property represented by the `Property` object is either `null` (if it has single cardinality) or refers to an empty collection (if it has list or enumeration cardinality).
`static int`	`NO_VALUE_AS_INT` An `int` value associated with the `NO_VALUE` instance of this class.
`static PropertyState`	`REFERENCE` Indicates that the `Property` object holds an `ObjectReference` object specifying a reference to the object returned by an object-valued Content Engine property.
`static int`	`REFERENCE_AS_INT` An `int` value associated with the `REFERENCE` instance of this class.
`static PropertyState`	`RETRIEVAL_ERROR` Indicates that the `Property` object holds an `EngineRuntimeException` object, which represents an error that has occurred during retrieval of a Content Engine property value.
`static int`	`RETRIEVAL_ERROR_AS_INT` An `int` value associated with the `RETRIEVAL_ERROR` instance of this class.
`static PropertyState`	`UNEVALUATED` Indicates that the `Property` object represents an object-valued Content Engine property but does not hold its object value and does not have any information identifying the object.
`static int`	`UNEVALUATED_AS_INT` An `int` value associated with the `UNEVALUATED` instance of this class.
`static PropertyState`	`VALUE` Indicates that the `Property` object holds the value of the Content Engine property that it represents.
`static int`	`VALUE_AS_INT` An `int` value associated with the `VALUE` instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static PropertyState`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated `int` value.
`int`	`getValue()` Returns an `int` 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
  - VALUE_AS_INT
```
public static final int VALUE_AS_INT
```
    An int value associated with the VALUE 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
  - VALUE
```
public static final PropertyState VALUE
```
    Indicates that the Property object holds the value of the Content Engine property that it represents.
  - NO_VALUE_AS_INT
```
public static final int NO_VALUE_AS_INT
```
    An int value associated with the NO_VALUE 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
  - NO_VALUE
```
public static final PropertyState NO_VALUE
```
    Indicates that the Content Engine property represented by the Property object is either null (if it has single cardinality) or refers to an empty collection (if it has list or enumeration cardinality).
  - REFERENCE_AS_INT
```
public static final int REFERENCE_AS_INT
```
    An int value associated with the REFERENCE 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
  - REFERENCE
```
public static final PropertyState REFERENCE
```
    Indicates that the Property object holds an ObjectReference object specifying a reference to the object returned by an object-valued Content Engine property. The object reference contains information that identifies the object but does not contain the object itself.
  - UNEVALUATED_AS_INT
```
public static final int UNEVALUATED_AS_INT
```
    An int value associated with the UNEVALUATED 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
  - UNEVALUATED
```
public static final PropertyState UNEVALUATED
```
    Indicates that the Property object represents an object-valued Content Engine property but does not hold its object value and does not have any information identifying the object.
  - RETRIEVAL_ERROR_AS_INT
```
public static final int RETRIEVAL_ERROR_AS_INT
```
    An int value associated with the RETRIEVAL_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
  - RETRIEVAL_ERROR
```
public static final PropertyState RETRIEVAL_ERROR
```
    Indicates that the Property object holds an EngineRuntimeException object, which represents an error that has occurred during retrieval of a Content Engine property value.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns an int value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - getInstanceFromInt
```
public static PropertyState getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated int value.
    
    Parameters:
    value - An int value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
  - 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.

Methods inherited from class java.lang.Object

VALUE_AS_INT

VALUE

NO_VALUE_AS_INT

NO_VALUE

REFERENCE_AS_INT

REFERENCE

UNEVALUATED_AS_INT

UNEVALUATED

RETRIEVAL_ERROR_AS_INT

RETRIEVAL_ERROR

getValue

getInstanceFromInt

toString