com.canto.cumulus.prefs

Class FieldLinkingList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.FieldLinkingList

public class FieldLinkingList
extends ListPackManager

This class manages a list of module fields linked to a catalog field.

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
CatalogLinkedField	createCatalogLinkedField(GUID moduleGUID, java.lang.String moduleName, GUID fieldGUID, java.lang.String fieldName) Creates a new entry for the given module UID, module name, field UID and field name.
CatalogLinkedField	getCatalogLinkedField(java.lang.String moduleGuid, java.lang.String fieldGuid) Returns the entry for the given module UID and module field UID.
java.util.List<CatalogLinkedField>	getCatalogLinkedFields() Returns a list of all contained entries.
void	remove(CatalogLinkedField catalogLinkedField) Removes the given entry from this list.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

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

Method Detail

createCatalogLinkedField

public CatalogLinkedField createCatalogLinkedField(GUID moduleGUID,
                                          java.lang.String moduleName,
                                          GUID fieldGUID,
                                          java.lang.String fieldName)

Creates a new entry for the given module UID, module name, field UID and field name.

Parameters:

moduleGUID - GUID of the module being linked

moduleName - display name for the module

fieldGUID - GUID of the field to link to this catalog field

fieldName - display name for module field linked to this catalog field

Returns:

the new created entry or the existing one

getCatalogLinkedFields

public java.util.List<CatalogLinkedField> getCatalogLinkedFields()

Returns a list of all contained entries.

Returns:

list of CatalogLinkedField instances

getCatalogLinkedField

public CatalogLinkedField getCatalogLinkedField(java.lang.String moduleGuid,
                                       java.lang.String fieldGuid)

Returns the entry for the given module UID and module field UID.

Parameters:

moduleGuid - the module UID

fieldGuid - the field UID

Returns:

the found field for the given values or null if not found

remove

public void remove(CatalogLinkedField catalogLinkedField)

Removes the given entry from this list.

Parameters:

catalogLinkedField - the entry to remove