Content Engine Java API: ChoiceType

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

All Implemented Interfaces:

java.io.Serializable
```
public final class ChoiceType
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that specify the type of data that a Choice object represents. These constants are used in conjunction with the ChoiceType property to specify whether a given Choice object represents an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type Choice objects, or a group node for a nested collection of string-type Choice objects.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ChoiceType`	`INTEGER` Specifies a `Choice` object that represents an integer-type choice item.
`static int`	`INTEGER_AS_INT` An `int` value associated with the INTEGER instance of this class.
`static ChoiceType`	`MIDNODE_INTEGER` Specifies a `Choice` object that acts as a group node for a nested collection of integer-type `Choice` objects.
`static int`	`MIDNODE_INTEGER_AS_INT` An `int` value associated with the MIDNODE_INTEGER instance of this class.
`static ChoiceType`	`MIDNODE_STRING` Specifies a `Choice` object that acts as a group node for a nested collection of string-type `Choice` objects.
`static int`	`MIDNODE_STRING_AS_INT` An `int` value associated with the MIDNODE_STRING instance of this class.
`static ChoiceType`	`STRING` Specifies a `Choice` object that represents a string-type choice item.
`static int`	`STRING_AS_INT` An `int` value associated with the STRING instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static ChoiceType`	`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
  - MIDNODE_STRING_AS_INT
```
public static final int MIDNODE_STRING_AS_INT
```
    An int value associated with the MIDNODE_STRING 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
  - MIDNODE_STRING
```
public static final ChoiceType MIDNODE_STRING
```
    Specifies a Choice object that acts as a group node for a nested collection of string-type Choice objects. This collection is represented by a com.filenet.api.collection.ChoiceList object returned by the ChoiceValues property. Each Choice object in this collection must represent either a string-type choice item or a group node for a nested collection of string-type Choice objects.
  - INTEGER_AS_INT
```
public static final int INTEGER_AS_INT
```
    An int value associated with the INTEGER 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
  - INTEGER
```
public static final ChoiceType INTEGER
```
    Specifies a Choice object that represents an integer-type choice item. This type of choice item stores a single integer value with its ChoiceIntegerValue property. An integer-type choice item must belong to an integer-type choice list and the value of its ChoiceIntegerValue property can only be assigned to an integer-valued property that has been associated with this choice list.
  - MIDNODE_INTEGER_AS_INT
```
public static final int MIDNODE_INTEGER_AS_INT
```
    An int value associated with the MIDNODE_INTEGER 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
  - MIDNODE_INTEGER
```
public static final ChoiceType MIDNODE_INTEGER
```
    Specifies a Choice object that acts as a group node for a nested collection of integer-type Choice objects. This collection is represented by a com.filenet.api.collection.ChoiceList object returned by the ChoiceValues property. Each Choice object in this collection must represent either an integer-type choice item or a group node for a nested collection of integer-type Choice objects.
  - STRING_AS_INT
```
public static final int STRING_AS_INT
```
    An int value associated with the STRING 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
  - STRING
```
public static final ChoiceType STRING
```
    Specifies a Choice object that represents a string-type choice item. This type of choice item stores a single string value with its ChoiceStringValue property. A string-type choice item must belong to a string-type choice list and the value of its ChoiceStringValue property can only be assigned to a string-valued property that has been associated with this choice list.
- 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 ChoiceType 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()

Methods inherited from class java.lang.Object

MIDNODE_STRING_AS_INT

MIDNODE_STRING

INTEGER_AS_INT

INTEGER

MIDNODE_INTEGER_AS_INT

MIDNODE_INTEGER

STRING_AS_INT

STRING

getValue

toString

getInstanceFromInt