FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface Choice

All Superinterfaces:
java.io.Serializable, Value
All Known Subinterfaces:
Choice

public interface Choice
extends Value, java.io.Serializable

A Choice object is an element in a ChoiceList collection and represents a possible value of a property. The Choice interface extends the Value interface and adds methods to return information about a Choice object (such as its display name and data type). String and integer are the only allowable data types for a Choice object. Note that the CS Java Connector provides limited support for CVL plugin data types; that is, you can read values from properties that are configured with CVL plugins, but you cannot set values for these properties.

You cannot create a new Choice object via the CS Java Connector. To instantiate a persisted one, instantiate a ChoiceList collection, then return a Choice object from the collection. See the ChoiceList interface for ways to instantiate a ChoiceList collection.

See Also:
CS Java Toolkit Developer's Guide

Field Summary
static int CHOICE_INTEGER
          Value of 0; integer data type.
static int CHOICE_MID_NODE_INTEGER
          

Not Implemented in CS Java Connector v3.0.

static int CHOICE_MID_NODE_STRING
          

Not Implemented in CS Java Connector v3.0.

static int CHOICE_STRING
          Value of 1; string data type.
 
Method Summary
 ChoiceList getContainedChoices()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getLabel()
          Returns a user-comprehensible, displayable name for this Choice object.
 java.lang.String getName()
          Returns the symbolic name for this Choice object.
 int getTypeId()
          Returns the data type of this Choice object.
 boolean hasContainedChoices()
          

Not Implemented in CS Java Connector v3.0.

 
Methods inherited from interface com.filenet.wcm.api.Value
equals, getBinaryValue, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getStringValue, getType, getValue, getValuesValue, hashCode, hasNullValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue
 

Field Detail

CHOICE_INTEGER

public static final int CHOICE_INTEGER
Value of 0; integer data type.

See Also:
Constant Field Values

CHOICE_STRING

public static final int CHOICE_STRING
Value of 1; string data type.

See Also:
Constant Field Values

CHOICE_MID_NODE_INTEGER

public static final int CHOICE_MID_NODE_INTEGER

Not Implemented in CS Java Connector v3.0.

Value of 2; mid-node integer data type.

See Also:
Constant Field Values

CHOICE_MID_NODE_STRING

public static final int CHOICE_MID_NODE_STRING

Not Implemented in CS Java Connector v3.0.

Value of 3; mid-node string data type.

See Also:
Constant Field Values
Method Detail

getLabel

public java.lang.String getLabel()
Returns a user-comprehensible, displayable name for this Choice object. (This is the DisplayName property for the Choice object. Note that DisplayName can be localized, whereas the SymbolicName returned in the getName method cannot.)

Returns:
A String that specifies the display name for this Choice object.

getName

public java.lang.String getName()
Returns the symbolic name for this Choice object. (This is the SymbolicName for the Choice object from the object's property description.)

Returns:
A String that specifies the symbolic name for this Choice object.

getContainedChoices

public ChoiceList getContainedChoices()

Not Implemented in CS Java Connector v3.0.

Returns a ChoiceList collection whose elements are the hierarchical choices contained in this Choice object. Call hasContainedChoices to determine if the Choice object has a contained ChoiceList collection. Note, however, that even if hasContainedChoices returns true, getContainedChoices will return null if your application did not fetch enough levels of ChoiceList collection objects. For example, if you specify too low of a depth in a call to ObjectStore.getChoiceLists, then attempt to obtain a Choice object's contained choices beyond that depth, your resulting ChoiceList collection object will be null.

Returns:
A ChoiceList collection whose Choice elements are the hierarchical choices contained below this Choice object.

hasContainedChoices

public boolean hasContainedChoices()

Not Implemented in CS Java Connector v3.0.

Specifies whether this Choice object has hierarchical choices contained in a ChoiceList collection. Note that even if this method returns true, a call to getContainedChoices can return null if your application did not fetch enough levels of ChoiceList collection objects (see getContainedChoices for more information).

Returns:
true if this Choice object has hierarchical choices contained in a ChoiceList collection; otherwise returns false.

getTypeId

public int getTypeId()
Returns the data type of this Choice object.

Returns:
See the Choice interface's constants for possible return values.

FileNet Content Services
Java Connector v3.0