com.canto.cumulus

Class FieldList

java.lang.Object

com.canto.cumulus.FieldList

public abstract class FieldList
extends java.lang.Object

The FieldList object is used to maintain a collection of field entries. It's meaning depends on it's origin:

• com.canto.cumulus.FieldDefinition#getLinkedFieldList: returns the list of linked fields for the field referred by the FieldDefinition object. By default the linked field list for a given field is empty, unless an explicit field linking has been defined. Cumulus also performs automatic field linking for all module fields that match the field GUID or name. This list of matching field can be retrieved by using the FieldList#addAllMatchingModuleFields().
• com.canto.cumulus.Layout#getAvailableFields: returns a list of fields that can be filled during cataloging (adding) or updating of records if the fields are part of the catalog's record layout. The fields in this list are not necessarily part of the record layout, but can be used to obtain information about the fields that can be filled by the cataloger, filters and the application.

Constructor Summary

Constructors

Constructor and Description
FieldList()

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	countFieldListEntries() Returns the number of entries in the list.
abstract CumulusSession	getCumulusSession() Returns the current CumulusSession object.
abstract FieldListEntry	getFieldListEntry(int index) Returns an entry by index.
abstract void	moveFieldListEntry(int from, int to) Moves an entry within the list.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldList

public FieldList()

Method Detail

getCumulusSession

public abstract CumulusSession getCumulusSession()

Returns the current CumulusSession object.

Returns:

the current CumulusSession object.

countFieldListEntries

public abstract int countFieldListEntries()

Returns the number of entries in the list.

Returns:

the number of entries in the list.

getFieldListEntry

public abstract FieldListEntry getFieldListEntry(int index)

Returns an entry by index.

Parameters:

index - the entry's index in the list.

Returns:

an entry by index.

moveFieldListEntry

public abstract void moveFieldListEntry(int from,
                      int to)

Moves an entry within the list. The index of an entry in the list determines the module that will first fill the field value.

Parameters:

from - the entry's old index in the list.

to - the entry's new index in the list.