Content Engine Java API: Cardinality

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

All Implemented Interfaces:

java.io.Serializable
```
public final class Cardinality
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that specify whether a property can hold a single value (single cardinality) or a collection of multiple values (list or enumeration cardinality).

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Cardinality`	`ENUM` Specifies a property with enumeration cardinality.
`static int`	`ENUM_AS_INT` An `int` value associated with the ENUM instance of this class.
`static Cardinality`	`LIST` Specifies a property with list cardinality.
`static int`	`LIST_AS_INT` An `int` value associated with the LIST instance of this class.
`static Cardinality`	`SINGLE` Specifies a property with single cardinality.
`static int`	`SINGLE_AS_INT` An `int` value associated with the SINGLE instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static Cardinality`	`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
  - LIST_AS_INT
```
public static final int LIST_AS_INT
```
    An int value associated with the LIST 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
  - LIST
```
public static final Cardinality LIST
```
    Specifies a property with list cardinality. A property with list cardinality returns a list collection. A list collection is a collection of ordered items that can either be modifiable (allowing items to be inserted, replaced, or deleted) or read-only. These items need not be unique and can be traversed in any order. When you access a list collection from the server, a complete copy of it is created on your client application, which you can iterate through one element at a time. The items in a list collection must all be of the same data type and must match the data type of the property that returns it. If the property returning a list collection is an object-valued property, all of the objects in the list collection must be dependent objects. A list collection can hold items of any data type (provided each item is of the same data type. However, if a list collection holds objects, they must all be dependent objects; only a set collection can hold independent objects. You cannot create a custom property with list cardinality.
  - SINGLE_AS_INT
```
public static final int SINGLE_AS_INT
```
    An int value associated with the SINGLE 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
  - SINGLE
```
public static final Cardinality SINGLE
```
    Specifies a property with single cardinality. A property with single cardinality returns a single value of the data type that the property can hold.
  - ENUM_AS_INT
```
public static final int ENUM_AS_INT
```
    An int value associated with the ENUM 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
  - ENUM
```
public static final Cardinality ENUM
```
    Specifies a property with enumeration cardinality. A property with enumeration cardinality is an object-valued property that returns a set collection. A set collection is a read-only collection of unique, unordered, independent objects that must be traversed sequentially. You can iterate through the items of a set collection one page of elements at a time from the server to your client application. However, if the collection changes on the server while you are iterating through it, the number, order, and values of the items in your client copy can change, even if you maintain the same reference to it. A set collection cannot hold any items other than independent objects. By contrast, a list collection can hold items of any data type, with the exception of independent objects.
- 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 Cardinality 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

LIST_AS_INT

LIST

SINGLE_AS_INT

SINGLE

ENUM_AS_INT

ENUM

getValue

toString

getInstanceFromInt