com.canto.cumulus.usermanagement

Class UserFieldDefinition

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.usermanagement.UserFieldDefinition

public class UserFieldDefinition
extends BaseManager

Instances of this class describe a field definition of the $Users catalog.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserFieldDefinition.FieldNames Wrapper class for field names.
static class	UserFieldDefinition.StringEnums Manager class for the string enum values.

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
GUID	getGUID() Returns the field GUID.
java.lang.String	getName(int languageId) Returns the field name for the specified language ID.
UserFieldDefinition.StringEnums	getStringEnums() Returns access to the string enum manager.
java.lang.String	getStringEnumValue(int enumID) Returns the string enum value for the specified enum id and the current language
java.lang.String	getStringEnumValue(int enumID, int languageId) If this field is a string enum field this method returns the enum value for the specified enum id and language id.
int	getType() Returns the field type.
int	getValueInterpretation() Returns the field value interpretation.
boolean	isReadOnly() Returns whether this field is read only
void	save() Saves this field definition.

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

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

Methods inherited from class java.lang.Object

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

Method Detail

getType

public int getType()

Returns the field type.

Returns:

the field type

getValueInterpretation

public int getValueInterpretation()

Returns the field value interpretation.

Returns:

the field value interpretation

isReadOnly

public boolean isReadOnly()

Returns whether this field is read only

Returns:

true if this field is read only

getGUID

public GUID getGUID()

Returns the field GUID.

Returns:

the field GUID

getName

public java.lang.String getName(int languageId)

Returns the field name for the specified language ID.

Parameters:

languageId - the id of the language to get the field name for

Returns:

name of this field

getStringEnumValue

public java.lang.String getStringEnumValue(int enumID,
                                  int languageId)

If this field is a string enum field this method returns the enum value for the specified enum id and language id.

Parameters:

enumID - the enum id to get the value for

languageId - the language id to get the value for

Returns:

the enum value

getStringEnums

public UserFieldDefinition.StringEnums getStringEnums()

Returns access to the string enum manager.

Returns:

the string enum manager

getStringEnumValue

public java.lang.String getStringEnumValue(int enumID)

Returns the string enum value for the specified enum id and the current language

Parameters:

enumID - the enum id to get the value for

Returns:

string enum value

save

public void save()

Saves this field definition.

Overrides:

save in class BaseManager