com.konakart.blif

Interface LanguageMgrIf

All Known Implementing Classes:

LanguageMgr

public interface LanguageMgrIf

LanguageMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
Language[]	getAllLanguages() Returns an array of language objects for all languages that have been defined in the system.
Language	getDefaultLanguage() Returns the default language object
int	getDefaultLanguageId() Returns the default language id
java.lang.String	getDefaultLocale()
Language	getLanguagePerCode(java.lang.String code) Retrieves the language object referenced by the code (i.e.
Language	getLanguagePerId(int languageId) Returns the language object with id = languageId.
Language[]	getLanguages(LanguageSearchIf languageSearchOptions) Returns an array of language objects for all languages that have been defined in the system that meet the defined search criteria.
NameValue[]	getMessages(int type, java.lang.String localeString) Used to fetch a message catalog for a locale and message type.
java.lang.String	getMsgValue(java.lang.String key, int type, java.lang.String localeString) Get an Application Message Value.
void	refreshConfigs() Refresh the configuration of the language manager

Method Detail

getLanguages

Language[] getLanguages(LanguageSearchIf languageSearchOptions)
                 throws org.apache.torque.TorqueException,
                        com.workingdogs.village.DataSetException,
                        com.konakart.app.KKException

Returns an array of language objects for all languages that have been defined in the system that meet the defined search criteria.

Parameters:

languageSearchOptions - the languageSearchOptions

Returns:

An array of language objects.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getAllLanguages

Language[] getAllLanguages()
                    throws org.apache.torque.TorqueException,
                           com.workingdogs.village.DataSetException,
                           com.konakart.app.KKException

Returns an array of language objects for all languages that have been defined in the system. Does not include the display-only languages.

Returns:

An array of language objects.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getDefaultLanguageId

int getDefaultLanguageId()
                  throws com.konakart.app.KKException

Returns the default language id

Returns:

Returns the default language id

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getDefaultLanguage

Language getDefaultLanguage()
                     throws com.konakart.app.KKException

Returns the default language object

Returns:

Returns the default language object

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getDefaultLocale

java.lang.String getDefaultLocale()
                           throws com.konakart.app.KKException

Returns:

Returns the default locale

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getLanguagePerId

Language getLanguagePerId(int languageId)
                   throws org.apache.torque.TorqueException,
                          com.workingdogs.village.DataSetException,
                          com.konakart.app.KKException

Returns the language object with id = languageId. Null if no object is found.

Parameters:

languageId - the languageId

Returns:

The language object with id = languageId. Null if no object is found.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getLanguagePerCode

Language getLanguagePerCode(java.lang.String code)
                     throws com.workingdogs.village.DataSetException,
                            org.apache.torque.TorqueException,
                            com.konakart.app.KKException

Retrieves the language object referenced by the code (i.e. en, de, es). This only returns the first language found with this code that is not a display-only language.

Parameters:

code - the code

Returns:

Returns a language object

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the language manager

Throws:

java.lang.Exception - an unexpected exception

getMsgValue

java.lang.String getMsgValue(java.lang.String key,
                             int type,
                             java.lang.String localeString)
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException,
                             com.konakart.app.KKException

Get an Application Message Value. If locale is null, the default locale is used.

Parameters:

key - the message key

type - the message type (should use KKConstants.MSG_TYP_APPLICATION for application messages)

localeString - the message locale (eg. "en_GB"). Default is used if left null.

Returns:

The message for the key, type and locale. If the message isn't found the String "[key:type:locale]" is returned.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getMessages

NameValue[] getMessages(int type,
                        java.lang.String localeString)
                 throws com.konakart.app.KKException,
                        com.workingdogs.village.DataSetException,
                        org.apache.torque.TorqueException

Used to fetch a message catalog for a locale and message type. If locale is null, the default locale is used.

Parameters:

type - the message type (should use KKConstants.MSG_TYP_APPLICATION for application messages)

localeString - the message locale (eg. "en_GB"). Default is used if left null.

Returns:

Returns and array of NameValue objects containing the message catalog

Throws:

com.konakart.app.KKException - an unexpected KKException exception

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)