ch.elca.el4j.util.codelist
Interface Codelist

All Superinterfaces:

SerializableEnum<String>

public interface Codelist
extends SerializableEnum<String>

Interface to be implemented by java enums which represent codelists. This interface is inspired by a concept for a central maintenance and management of codelists. These are deployed to software components for pure offline use. According to the concept, the enums implementing this interface are generated by a java code generator. For a convenient implementation of the described functionality use the CodelistUtility class in this package. Since the extensibility of enum types is not supported by the language construct, the functional implementation is provided in the CodelistUtility class.

Author:

Jonas Hauenstein (JHN)

File-location:

Codelist

Last check-in date:

2010-01-21 11:11:14 +0100 (Do, 21. Jan 2010) by jonasha for revision 4103

Method Summary

int	getID() Getter for the globally unique ID of the code.
int	getIntCode() Getter for the intCode of the code.
String	getLongText(Locale lang) Getter for the long textual description of the code in a given language.
String	getShortText(Locale lang) Getter for the short textual description of the code in a given language.

Methods inherited from interface ch.elca.el4j.util.codingsupport.SerializableEnum

getValue

Method Detail

getID

int getID()

Getter for the globally unique ID of the code. This ID should be uniquely defined over all codes in all available codelists.

Returns:

The unique ID of the code

getIntCode

int getIntCode()

Getter for the intCode of the code. This is defined to be a number representing the code inside the codelist.

Returns:

The intCode of the code

getShortText

String getShortText(Locale lang)

Getter for the short textual description of the code in a given language.

Parameters:

lang - Java Locale of the desired language for the returned text

Returns:

The short textual description of the code

getLongText

String getLongText(Locale lang)

Getter for the long textual description of the code in a given language.

Parameters:

lang - Java Locale of the desired language for the returned text

Returns:

The short textual description of the code