org.osid.locale

Interface LocaleProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

LocaleManager, LocaleProxyManager

public interface LocaleProfile
extends OsidProfile

The locale profile describes the interoperability of locale services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getCalendarTypesForFormatting() Gets all the calendar types for which formats are available.
TypeList	getCalendarTypesForSource(Type sourceCalendarType) Gets the list of target calendar types for a given source calendar type.
TypeList	getCalendarTypesForTimeType(Type timeType) Gets the list of calendar types supported for a given time type where they are both used in a DateTime.
TypeList	getCoordinateFormatTypesForCoordinateType(Type coordinateType) Gets the list of coordinate format types for a given coordinate type.
TypeList	getCoordinateTypesForFormatting() Gets all the coordinate types for which formatting is available.
TypeList	getCoordinateTypesForSource(Type sourceCoordinateType) Gets the list of target coordinate types for a given source coordinate type.
TypeList	getCurrencyFormatTypesForCurrencyType(Type currencyType) Gets the list of currency format types for a given currency type.
TypeList	getCurrencyTypesForFormatting() Gets all the currency types for which formatting is available.
TypeList	getCurrencyTypesForSource(Type sourceCurrencyType) Gets the list of target currency types for a given source currency type.
TypeList	getDateFormatTypesForCalendarType(Type calendarType) Gets the list of date format types for a given calendar type.
TypeList	getFormatTypesForSource(Type sourceFormatType) Gets the list of target format types for a given source spatial unit type.
TypeList	getLanguageTypesForSource(Type sourceLanguageType, Type sourceScriptType) Gets the list of target language types for a given source language type.
TypeList	getNumericFormatTypes() Gets all the numeric format types supported.
TypeList	getScriptTypesForLanguageType(Type languageType) Gets the list of script types available for a given language type.
TypeList	getSourceCalendarTypes() Gets the list of source calendar types.
TypeList	getSourceCoordinateTypes() Gets the list of source coordinate types.
TypeList	getSourceCurrencyTypes() Gets the list of source currency types.
TypeList	getSourceFormatTypes() Gets the list of source format types.
TypeList	getSourceLanguageTypes() Gets all the source language types supported.
TypeList	getSourceSpatialUnitRecordTypes() Gets the list of source spatial unit record types.
TypeList	getSourceTimeTypes() Gets the list of source time types.
TypeList	getSourceUnitTypes() Gets all the source unit types supported.
TypeList	getSpatialUnitRecordTypesForSource(Type sourceSpatialUnitRecordType) Gets the list of target spatial unit types for a given source spatial unit type.
TypeList	getTimeFormatTypesForTimeType(Type timeType) Gets the list of time format types for a given time type.
TypeList	getTimeTypesForCalendarType(Type calendarType) Gets the list of time types supported for a given calendar type where they are both used in a DateTime.
TypeList	getTimeTypesForFormatting() Gets all the time types for which formatting is available.
TypeList	getTimeTypesForSource(Type sourceTimeType) Gets the list of target time types for a given source time type.
TypeList	getUnitTypesForSource(Type sourceUnitType) Gets the list of target measure types for a given source measure type.
boolean	supportsCalendarConversion() Tests if calendar conversion is supported.
boolean	supportsCalendarFormatting() Tests if calendar formatting is supported.
boolean	supportsCalendarInfo() Tests if a calendar informational service is supported.
boolean	supportsCalendarTimeTypes(Type calendarType, Type timeType) Tests if a given calendar and time type are used together in a DateTime.
boolean	supportsCalendarTypesForConversion(Type sourceCalendarType, Type targetCalendarType) Tests if a given calendar conversion is supported.
boolean	supportsCalendarTypesForFormatting(Type calendarType, Type timeType, Type dateFormatType, Type timeFormatType) Tests if a given calendaring formatting is supported.
boolean	supportsCoordinateConversion() Tests if coordnate conversion is supported.
boolean	supportsCoordinateFormatting() Tests if coordinate formatting is supported.
boolean	supportsCoordinateTypesForConversion(Type sourceCoordinateType, Type targetCoordinateType) Tests if a given coordinate type for conversion is supported.
boolean	supportsCoordinateTypesForFormatting(Type coordinateType, Type coordinateFormatType) Tests if a given coordinate formatting is supported.
boolean	supportsCurrencyConversion() Tests if currency conversion is supported.
boolean	supportsCurrencyFormatting() Tests if currency formatting is supported.
boolean	supportsCurrencyTypesForConversion(Type sourceCurrencyType, Type targetCurrencyType) Tests if a given currency conversion is supported.
boolean	supportsCurrencyTypesForFormatting(Type currencyType, Type numericFormatType) Tests if a given currency formatting is supported.
boolean	supportsFormatConversion() Tests if format conversion is supported.
boolean	supportsFormatTypesForConversion(Type sourceFormatType, Type targetFormatType) Tests if a given format conversion is supported.
boolean	supportsLanguageTypesForTranslation(Type sourceLanguageType, Type sourceScriptType, Type targetLanguageType, Type targetScriptType) Tests if a given language translation is supported.
boolean	supportsNumericFormatting() Tests if numeric formatting is supported.
boolean	supportsNumericFormatTypes(Type numericFormatType) Tests if a given numeric format type is supported.
boolean	supportsSpatialUnitConversion() Tests if spatial unit conversion is supported.
boolean	supportsSpatialUnitRecordTypesForConversion(Type sourceSpatialUnitRecordType, Type targetSpatialUnitRecordType) Tests if a given spatial unit conversion is supported.
boolean	supportsTimeTypesForConversion(Type sourceTimeType, Type targetTimeType) Tests if a given time conversion is supported.
boolean	supportsTranslation() Tests if translation is supported.
boolean	supportsTranslationAdmin() Tests if translation administration is supported.
boolean	supportsUnitConversion() Tests if unit conversion is supported.
boolean	supportsUnitTypesForConversion(Type sourceUnitType, Type targetUnitType) Tests if a given measure conversion is supported.
boolean	supportsVisibleFederation() Tests if visible federation is supported.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if visible federation is supported.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTranslation

boolean supportsTranslation()

Tests if translation is supported.

Returns:

true if translation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTranslationAdmin

boolean supportsTranslationAdmin()

Tests if translation administration is supported.

Returns:

true if translation administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsNumericFormatting

boolean supportsNumericFormatting()

Tests if numeric formatting is supported.

Returns:

true if numeric formatting is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCalendarFormatting

boolean supportsCalendarFormatting()

Tests if calendar formatting is supported.

Returns:

true if calendar formatting is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCurrencyFormatting

boolean supportsCurrencyFormatting()

Tests if currency formatting is supported.

Returns:

true if currency formatting is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCoordinateFormatting

boolean supportsCoordinateFormatting()

Tests if coordinate formatting is supported.

Returns:

true if coordinate formatting is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsUnitConversion

boolean supportsUnitConversion()

Tests if unit conversion is supported.

Returns:

true if unit conversion is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCurrencyConversion

boolean supportsCurrencyConversion()

Tests if currency conversion is supported.

Returns:

true if currency conversion is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCalendarConversion

boolean supportsCalendarConversion()

Tests if calendar conversion is supported.

Returns:

true if calendar conversion is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCoordinateConversion

boolean supportsCoordinateConversion()

Tests if coordnate conversion is supported.

Returns:

true if coordinate conversion is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSpatialUnitConversion

boolean supportsSpatialUnitConversion()

Tests if spatial unit conversion is supported.

Returns:

true if spatial unit conversion is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFormatConversion

boolean supportsFormatConversion()

Tests if format conversion is supported.

Returns:

true if format conversion is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCalendarInfo

boolean supportsCalendarInfo()

Tests if a calendar informational service is supported.

Returns:

true if calendar info is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLanguageTypesForTranslation

boolean supportsLanguageTypesForTranslation(Type sourceLanguageType,
                                          Type sourceScriptType,
                                          Type targetLanguageType,
                                          Type targetScriptType)

Tests if a given language translation is supported.

Parameters:

sourceLanguageType - the type of the source language

sourceScriptType - the type of the source script

targetLanguageType - the type of the target language

targetScriptType - the type of the target script

Returns:

true if the given source and target translation is supported, false otherwise

Throws:

NullArgumentException - sourceLanguageType, sourceScriptType, targetLanguageType or targetScriptType is null

Compliance:

mandatory - This method must be implemented.

getLanguageTypesForSource

TypeList getLanguageTypesForSource(Type sourceLanguageType,
                                 Type sourceScriptType)

Gets the list of target language types for a given source language type.

Parameters:

sourceLanguageType - the type of the source language

sourceScriptType - the type of the source script

Returns:

the list of supported types for the given source language type

Throws:

NullArgumentException - sourceLanguageType is null

Compliance:

mandatory - This method must be implemented.

getSourceLanguageTypes

TypeList getSourceLanguageTypes()

Gets all the source language types supported.

Returns:

the list of supported language types

Compliance:

mandatory - This method must be implemented.

getScriptTypesForLanguageType

TypeList getScriptTypesForLanguageType(Type languageType)

Gets the list of script types available for a given language type.

Parameters:

languageType - the type of the language

Returns:

the list of supported script types for the given language type

Throws:

NullArgumentException - languageType is null

Compliance:

mandatory - This method must be implemented.

supportsNumericFormatTypes

boolean supportsNumericFormatTypes(Type numericFormatType)

Tests if a given numeric format type is supported.

Parameters:

numericFormatType - the type of the numeric format

Returns:

true if the given numeric format type is supported, false otherwise

Throws:

NullArgumentException - numericFormatType is null

Compliance:

mandatory - This method must be implemented.

getNumericFormatTypes

TypeList getNumericFormatTypes()

Gets all the numeric format types supported.

Returns:

the list of supported numeric format types

Compliance:

mandatory - This method must be implemented.

supportsCalendarTypesForFormatting

boolean supportsCalendarTypesForFormatting(Type calendarType,
                                         Type timeType,
                                         Type dateFormatType,
                                         Type timeFormatType)

Tests if a given calendaring formatting is supported.

Parameters:

calendarType - the type of the calendar

timeType - the type of the time system

dateFormatType - the type of the output date format

timeFormatType - the type of the output time format

Returns:

true if formatting with the given types is supported, false otherwise

Throws:

NullArgumentException - calendarType, calendarFormatType, timeType, or timeFormatType is null

Compliance:

mandatory - This method must be implemented.

getCalendarTypesForFormatting

TypeList getCalendarTypesForFormatting()

Gets all the calendar types for which formats are available.

Returns:

the list of calendar types

Compliance:

mandatory - This method must be implemented.

getDateFormatTypesForCalendarType

TypeList getDateFormatTypesForCalendarType(Type calendarType)

Gets the list of date format types for a given calendar type.

Parameters:

calendarType - the type of the calendar

Returns:

the list of supported date format types

Throws:

NullArgumentException - calendarType is null

Compliance:

mandatory - This method must be implemented.

getTimeTypesForFormatting

TypeList getTimeTypesForFormatting()

Gets all the time types for which formatting is available.

Returns:

the list of time types

Compliance:

mandatory - This method must be implemented.

getTimeFormatTypesForTimeType

TypeList getTimeFormatTypesForTimeType(Type timeType)

Gets the list of time format types for a given time type.

Parameters:

timeType - the type of the time

Returns:

the list of supported time format types

Throws:

NullArgumentException - timeType is null

Compliance:

mandatory - This method must be implemented.

supportsCurrencyTypesForFormatting

boolean supportsCurrencyTypesForFormatting(Type currencyType,
                                         Type numericFormatType)

Tests if a given currency formatting is supported.

Parameters:

currencyType - the type of the currency

numericFormatType - the type of the output currency format

Returns:

true if formatting with the given types is supported, false otherwise

Throws:

NullArgumentException - currencyType or numericFormatType is null

Compliance:

mandatory - This method must be implemented.

getCurrencyTypesForFormatting

TypeList getCurrencyTypesForFormatting()

Gets all the currency types for which formatting is available.

Returns:

the list of currency types

Compliance:

mandatory - This method must be implemented.

getCurrencyFormatTypesForCurrencyType

TypeList getCurrencyFormatTypesForCurrencyType(Type currencyType)

Gets the list of currency format types for a given currency type.

Parameters:

currencyType - the type of the currency

Returns:

the list of supported currency format types

Throws:

NullArgumentException - currencyType is null

Compliance:

mandatory - This method must be implemented.

supportsCoordinateTypesForFormatting

boolean supportsCoordinateTypesForFormatting(Type coordinateType,
                                           Type coordinateFormatType)

Tests if a given coordinate formatting is supported.

Parameters:

coordinateType - the type of the coordinate

coordinateFormatType - the type of the output coordinate format

Returns:

true if formatting with the given types is supported, false otherwise

Throws:

NullArgumentException - cooridinateType or coodinateFormatType is null

Compliance:

mandatory - This method must be implemented.

getCoordinateTypesForFormatting

TypeList getCoordinateTypesForFormatting()

Gets all the coordinate types for which formatting is available.

Returns:

the list of coordinate types

Compliance:

mandatory - This method must be implemented.

getCoordinateFormatTypesForCoordinateType

TypeList getCoordinateFormatTypesForCoordinateType(Type coordinateType)

Gets the list of coordinate format types for a given coordinate type.

Parameters:

coordinateType - the type of the coordinate

Returns:

the list of supported coordinate format types

Throws:

NullArgumentException - coordinaterType is null

Compliance:

mandatory - This method must be implemented.

supportsUnitTypesForConversion

boolean supportsUnitTypesForConversion(Type sourceUnitType,
                                     Type targetUnitType)

Tests if a given measure conversion is supported.

Parameters:

sourceUnitType - the type of the source measure

targetUnitType - the type of the target measure

Returns:

true if the given source and target conversion is supported, false otherwise

Throws:

NullArgumentException - sourceUnitType or targetUnitType is null

Compliance:

mandatory - This method must be implemented.

getUnitTypesForSource

TypeList getUnitTypesForSource(Type sourceUnitType)

Gets the list of target measure types for a given source measure type.

Parameters:

sourceUnitType - the type of the source measure

Returns:

the list of supported target measure types

Throws:

NullArgumentException - sourceUnitType is null

Compliance:

mandatory - This method must be implemented.

getSourceUnitTypes

TypeList getSourceUnitTypes()

Gets all the source unit types supported.

Returns:

the list of supported source unit types

Compliance:

mandatory - This method must be implemented.

supportsCurrencyTypesForConversion

boolean supportsCurrencyTypesForConversion(Type sourceCurrencyType,
                                         Type targetCurrencyType)

Tests if a given currency conversion is supported.

Parameters:

sourceCurrencyType - the type of the source currency

targetCurrencyType - the type of the target currency

Returns:

true if the given source and target conversion is supported, false otherwise

Throws:

NullArgumentException - sourceCurrencyType or targetCurrencyType is null

Compliance:

mandatory - This method must be implemented.

getCurrencyTypesForSource

TypeList getCurrencyTypesForSource(Type sourceCurrencyType)

Gets the list of target currency types for a given source currency type.

Parameters:

sourceCurrencyType - the type of the source currency

Returns:

the list of supported currency types

Throws:

NullArgumentException - sourceCurrencyType is null

Compliance:

mandatory - This method must be implemented.

getSourceCurrencyTypes

TypeList getSourceCurrencyTypes()

Gets the list of source currency types.

Returns:

the list of supported source currency types

Compliance:

mandatory - This method must be implemented.

supportsCalendarTypesForConversion

boolean supportsCalendarTypesForConversion(Type sourceCalendarType,
                                         Type targetCalendarType)

Tests if a given calendar conversion is supported.

Parameters:

sourceCalendarType - the type of the source calendar

targetCalendarType - the type of the target calendar

Returns:

true if the given source and target conversion is supported, false otherwise

Throws:

NullArgumentException - sourceCalendarType or targetCalendarType is null

Compliance:

mandatory - This method must be implemented.

getCalendarTypesForSource

TypeList getCalendarTypesForSource(Type sourceCalendarType)

Gets the list of target calendar types for a given source calendar type.

Parameters:

sourceCalendarType - the type of the source calendar

Returns:

the list of supported calendar types

Throws:

NullArgumentException - sourceCalendarType is null

Compliance:

mandatory - This method must be implemented.

getSourceCalendarTypes

TypeList getSourceCalendarTypes()

Gets the list of source calendar types.

Returns:

the list of supported source calendar types

Compliance:

mandatory - This method must be implemented.

supportsTimeTypesForConversion

boolean supportsTimeTypesForConversion(Type sourceTimeType,
                                     Type targetTimeType)

Tests if a given time conversion is supported.

Parameters:

sourceTimeType - the type of the source time

targetTimeType - the type of the target time

Returns:

true if the given source and target conversion is supported, false otherwise

Throws:

NullArgumentException - sourceTimeType or targetTimeType is null

Compliance:

mandatory - This method must be implemented.

getTimeTypesForSource

TypeList getTimeTypesForSource(Type sourceTimeType)

Gets the list of target time types for a given source time type.

Parameters:

sourceTimeType - the type of the source time

Returns:

the list of supported time types

Throws:

NullArgumentException - sourceTimeType is null

Compliance:

mandatory - This method must be implemented.

getSourceTimeTypes

TypeList getSourceTimeTypes()

Gets the list of source time types.

Returns:

the list of supported source time types

Compliance:

mandatory - This method must be implemented.

getTimeTypesForCalendarType

TypeList getTimeTypesForCalendarType(Type calendarType)

Gets the list of time types supported for a given calendar type where they are both used in a DateTime.

Parameters:

calendarType - the type of the calendar

Returns:

the list of supported time types

Throws:

NullArgumentException - calendarType is null

Compliance:

mandatory - This method must be implemented.

getCalendarTypesForTimeType

TypeList getCalendarTypesForTimeType(Type timeType)

Gets the list of calendar types supported for a given time type where they are both used in a DateTime.

Parameters:

timeType - the type of the time system

Returns:

the list of supported calendar types

Throws:

NullArgumentException - timeType is null

Compliance:

mandatory - This method must be implemented.

supportsCalendarTimeTypes

boolean supportsCalendarTimeTypes(Type calendarType,
                                Type timeType)

Tests if a given calendar and time type are used together in a DateTime.

Parameters:

calendarType - the type of the calendar

timeType - the type of the time system

Returns:

true if the given calendar and time types are supported, false otherwise

Throws:

NullArgumentException - calendarType or timeType is null

Compliance:

mandatory - This method must be implemented.

supportsCoordinateTypesForConversion

boolean supportsCoordinateTypesForConversion(Type sourceCoordinateType,
                                           Type targetCoordinateType)

Tests if a given coordinate type for conversion is supported.

Parameters:

sourceCoordinateType - the type of the source coordinate

targetCoordinateType - the type of the target coordinate

Returns:

true if the given source and target conversion is supported, false otherwise

Throws:

NullArgumentException - sourceCoordinateType or targetCoordinateType is null

Compliance:

mandatory - This method must be implemented.

getCoordinateTypesForSource

TypeList getCoordinateTypesForSource(Type sourceCoordinateType)

Gets the list of target coordinate types for a given source coordinate type.

Parameters:

sourceCoordinateType - the type of the source coordinate

Returns:

the list of supported target coordinate types

Throws:

NullArgumentException - sourceCoordinateType is null

Compliance:

mandatory - This method must be implemented.

getSourceCoordinateTypes

TypeList getSourceCoordinateTypes()

Gets the list of source coordinate types.

Returns:

the list of supported source coordinate types

Compliance:

mandatory - This method must be implemented.

supportsSpatialUnitRecordTypesForConversion

boolean supportsSpatialUnitRecordTypesForConversion(Type sourceSpatialUnitRecordType,
                                                  Type targetSpatialUnitRecordType)

Tests if a given spatial unit conversion is supported.

Parameters:

sourceSpatialUnitRecordType - the type of the source spatial unit record

targetSpatialUnitRecordType - the type of the target spatial unit record

Returns:

true if the given source and target conversion is supported, false otherwise

Throws:

NullArgumentException - sourceSpatialUnitRecordType or targetSpatialUnitRecordType is null

Compliance:

mandatory - This method must be implemented.

getSpatialUnitRecordTypesForSource

TypeList getSpatialUnitRecordTypesForSource(Type sourceSpatialUnitRecordType)

Gets the list of target spatial unit types for a given source spatial unit type.

Parameters:

sourceSpatialUnitRecordType - the type of the source spatial unit record

Returns:

the list of supported target spatial unit record types

Throws:

NullArgumentException - sourceSpatialUnitRecordType is null

Compliance:

mandatory - This method must be implemented.

getSourceSpatialUnitRecordTypes

TypeList getSourceSpatialUnitRecordTypes()

Gets the list of source spatial unit record types.

Returns:

the list of supported source spatial unit record types

Compliance:

mandatory - This method must be implemented.

supportsFormatTypesForConversion

boolean supportsFormatTypesForConversion(Type sourceFormatType,
                                       Type targetFormatType)

Tests if a given format conversion is supported.

Parameters:

sourceFormatType - the type of the source format

targetFormatType - the type of the target format

Returns:

true if the given source and target conversion is supported, false otherwise

Throws:

NullArgumentException - sourceFormatType or targetFormatType is null

Compliance:

mandatory - This method must be implemented.

getFormatTypesForSource

TypeList getFormatTypesForSource(Type sourceFormatType)

Gets the list of target format types for a given source spatial unit type.

Parameters:

sourceFormatType - the type of the source format

Returns:

the list of supported target format types

Throws:

NullArgumentException - sourceFormatType is null

Compliance:

mandatory - This method must be implemented.

getSourceFormatTypes

TypeList getSourceFormatTypes()

Gets the list of source format types.

Returns:

the list of supported source format types

Compliance:

mandatory - This method must be implemented.