|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.constants.PropertyState
public class PropertyState
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.
Field Summary | |
---|---|
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 | |
---|---|
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 |
---|
public static final int VALUE_AS_INT
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.
public static final PropertyState VALUE
Property
object holds the value of the Content Engine property
that it represents.
public static final int NO_VALUE_AS_INT
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.
public static final PropertyState NO_VALUE
Property
object
is either null
(if it has single cardinality) or refers to an empty collection
(if it has list or enumeration cardinality).
public static final int REFERENCE_AS_INT
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.
public static final PropertyState REFERENCE
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.
public static final int UNEVALUATED_AS_INT
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.
public static final PropertyState UNEVALUATED
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.
public static final int RETRIEVAL_ERROR_AS_INT
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.
public static final PropertyState RETRIEVAL_ERROR
Property
object holds an EngineRuntimeException
object, which represents an error that has occurred during retrieval of a Content Engine
property value.
Method Detail |
---|
public int getValue()
int
value associated with a specific instance of this class.
getInstanceFromInt(int)
public static PropertyState getInstanceFromInt(int value)
int
value.
value
- An int
value. (See the *_AS_INT
fields.)
public java.lang.String toString()
String
representation of this enumeration instance.
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |