com.canto.cumulus.prefs

Class CatalogFieldEnumListValueContainer

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.CatalogFieldEnumListValueContainer

public class CatalogFieldEnumListValueContainer
extends BaseManager

This class manages the entries for a string enum 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
int	createEnumEntry(java.lang.String defaultName) Adds a new enum entry with the given default value.
void	deleteEnumEntry(int oldid) Deletes the entry with the given ID without redirecting the records using this value to another enum entry.
void	deleteEnumEntry(int oldID, int replacementID) Deletes the entry with the given ID and redirects the records using this value to the given replacement enum entry.
CatalogFieldEnumListValueContainerCoreValueList	getCatalogFieldEnumListValueContainerCoreValueList() Returns the instance managing the different string enum values.
java.lang.String	getEnumDescription(int enumID, int languageID) Returns the enum description for the given ID and language.
java.util.List<java.lang.Integer>	getEnumKeys() Returns the list of enum IDs contained in this list.
java.lang.String	getEnumName(int enumID, int languageID) Returns the entry value for the given ID and language.
void	setEnumDescription(int enumID, int languageID, java.lang.String value) Sets the enum description for the specified enum ID and language.
void	setEnumName(int enumID, int languageID, java.lang.String value) Sets the enum value for the specified enum ID and language.

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

getCatalogFieldEnumListValueContainerCoreValueList

public CatalogFieldEnumListValueContainerCoreValueList getCatalogFieldEnumListValueContainerCoreValueList()

Returns the instance managing the different string enum values.

Returns:

instance managing the different string enum values

Since:

9.0

getEnumKeys

public java.util.List<java.lang.Integer> getEnumKeys()

Returns the list of enum IDs contained in this list.

Returns:

list of Integers

createEnumEntry

public int createEnumEntry(java.lang.String defaultName)

Adds a new enum entry with the given default value.

Parameters:

defaultName - new default value

Returns:

the new created entry

deleteEnumEntry

public void deleteEnumEntry(int oldid)

Deletes the entry with the given ID without redirecting the records using this value to another enum entry.

Parameters:

oldid - the ID of the entry to delete

deleteEnumEntry

public void deleteEnumEntry(int oldID,
                   int replacementID)

Deletes the entry with the given ID and redirects the records using this value to the given replacement enum entry.

Parameters:

oldID - the ID of the entry to delete

replacementID - the ID to use for redirection

getEnumName

public java.lang.String getEnumName(int enumID,
                           int languageID)

Returns the entry value for the given ID and language.

Parameters:

enumID - the enum ID

languageID - the language ID

Returns:

name for the given ID and language

setEnumName

public void setEnumName(int enumID,
               int languageID,
               java.lang.String value)

Sets the enum value for the specified enum ID and language.

Parameters:

enumID - the enum ID

languageID - the language to set

value - new enum value

getEnumDescription

public java.lang.String getEnumDescription(int enumID,
                                  int languageID)

Returns the enum description for the given ID and language.

Parameters:

enumID - the enum ID

languageID - the language ID

Returns:

description for the given ID and language

Since:

9.0

setEnumDescription

public void setEnumDescription(int enumID,
                      int languageID,
                      java.lang.String value)

Sets the enum description for the specified enum ID and language.

Parameters:

enumID - the enum ID

languageID - the language to set

value - new enum description