Interface LocaleProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
LocaleManager, LocaleProxyManager
The locale profile describes the interoperability of locale services.
-
Method Summary
Modifier and TypeMethodDescriptionGets all the calendar types for which formats are available.getCalendarTypesForSource(Type sourceCalendarType) Gets the list of target calendar types for a given source calendar type.getCalendarTypesForTimeType(Type timeType) Gets the list of calendar types supported for a given time type where they are both used in aDateTime.getCoordinateFormatTypesForCoordinateType(Type coordinateType) Gets the list of coordinate format types for a given coordinate type.Gets all the coordinate types for which formatting is available.getCoordinateTypesForSource(Type sourceCoordinateType) Gets the list of target coordinate types for a given source coordinate type.getCurrencyFormatTypesForCurrencyType(Type currencyType) Gets the list of currency format types for a given currency type.Gets all the currency types for which formatting is available.getCurrencyTypesForSource(Type sourceCurrencyType) Gets the list of target currency types for a given source currency type.getDateFormatTypesForCalendarType(Type calendarType) Gets the list of date format types for a given calendar type.getFormatTypesForSource(Type sourceFormatType) Gets the list of target format types for a given source spatial unit type.getLanguageTypesForSource(Type sourceLanguageType, Type sourceScriptType) Gets the list of target language types for a given source language type.Gets all the numeric format types supported.getScriptTypesForLanguageType(Type languageType) Gets the list of script types available for a given language type.Gets the list of source calendar types.Gets the list of source coordinate types.Gets the list of source currency types.Gets the list of source format types.Gets all the source language types supported.Gets the list of source spatial unit record types.Gets the list of source time types.Gets all the source unit types supported.getSpatialUnitRecordTypesForSource(Type sourceSpatialUnitRecordType) Gets the list of target spatial unit types for a given source spatial unit type.getTimeFormatTypesForTimeType(Type timeType) Gets the list of time format types for a given time type.getTimeTypesForCalendarType(Type calendarType) Gets the list of time types supported for a given calendar type where they are both used in aDateTime.Gets all the time types for which formatting is available.getTimeTypesForSource(Type sourceTimeType) Gets the list of target time types for a given source time type.getUnitTypesForSource(Type sourceUnitType) Gets the list of target measure types for a given source measure type.booleanTests if calendar conversion is supported.booleanTests if calendar formatting is supported.booleanTests if a calendar informational service is supported.booleansupportsCalendarTimeTypes(Type calendarType, Type timeType) Tests if a given calendar and time type are used together in aDateTime.booleansupportsCalendarTypesForConversion(Type sourceCalendarType, Type targetCalendarType) Tests if a given calendar conversion is supported.booleansupportsCalendarTypesForFormatting(Type calendarType, Type timeType, Type dateFormatType, Type timeFormatType) Tests if a given calendaring formatting is supported.booleanTests if coordnate conversion is supported.booleanTests if coordinate formatting is supported.booleansupportsCoordinateTypesForConversion(Type sourceCoordinateType, Type targetCoordinateType) Tests if a given coordinate type for conversion is supported.booleansupportsCoordinateTypesForFormatting(Type coordinateType, Type coordinateFormatType) Tests if a given coordinate formatting is supported.booleanTests if currency conversion is supported.booleanTests if currency formatting is supported.booleansupportsCurrencyTypesForConversion(Type sourceCurrencyType, Type targetCurrencyType) Tests if a given currency conversion is supported.booleansupportsCurrencyTypesForFormatting(Type currencyType, Type numericFormatType) Tests if a given currency formatting is supported.booleanTests if format conversion is supported.booleansupportsFormatTypesForConversion(Type sourceFormatType, Type targetFormatType) Tests if a given format conversion is supported.booleansupportsLanguageTypesForTranslation(Type sourceLanguageType, Type sourceScriptType, Type targetLanguageType, Type targetScriptType) Tests if a given language translation is supported.booleanTests if numeric formatting is supported.booleansupportsNumericFormatTypes(Type numericFormatType) Tests if a given numeric format type is supported.booleanTests if spatial unit conversion is supported.booleansupportsSpatialUnitRecordTypesForConversion(Type sourceSpatialUnitRecordType, Type targetSpatialUnitRecordType) Tests if a given spatial unit conversion is supported.booleansupportsTimeTypesForConversion(Type sourceTimeType, Type targetTimeType) Tests if a given time conversion is supported.booleanTests if translation is supported.booleanTests if translation administration is supported.booleanTests if unit conversion is supported.booleansupportsUnitTypesForConversion(Type sourceUnitType, Type targetUnitType) Tests if a given measure conversion is supported.booleanTests if visible federation is supported.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if visible federation is supported.- Returns:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTranslation
boolean supportsTranslation()Tests if translation is supported.- Returns:
trueif translation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTranslationAdmin
boolean supportsTranslationAdmin()Tests if translation administration is supported.- Returns:
trueif translation administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsNumericFormatting
boolean supportsNumericFormatting()Tests if numeric formatting is supported.- Returns:
trueif numeric formatting is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCalendarFormatting
boolean supportsCalendarFormatting()Tests if calendar formatting is supported.- Returns:
trueif calendar formatting is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCurrencyFormatting
boolean supportsCurrencyFormatting()Tests if currency formatting is supported.- Returns:
trueif currency formatting is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCoordinateFormatting
boolean supportsCoordinateFormatting()Tests if coordinate formatting is supported.- Returns:
trueif coordinate formatting is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsUnitConversion
boolean supportsUnitConversion()Tests if unit conversion is supported.- Returns:
trueif unit conversion is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCurrencyConversion
boolean supportsCurrencyConversion()Tests if currency conversion is supported.- Returns:
trueif currency conversion is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCalendarConversion
boolean supportsCalendarConversion()Tests if calendar conversion is supported.- Returns:
trueif calendar conversion is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCoordinateConversion
boolean supportsCoordinateConversion()Tests if coordnate conversion is supported.- Returns:
trueif coordinate conversion is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSpatialUnitConversion
boolean supportsSpatialUnitConversion()Tests if spatial unit conversion is supported.- Returns:
trueif spatial unit conversion is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFormatConversion
boolean supportsFormatConversion()Tests if format conversion is supported.- Returns:
trueif format conversion is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCalendarInfo
boolean supportsCalendarInfo()Tests if a calendar informational service is supported.- Returns:
trueif calendar info is supported,falseotherwise- 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 languagesourceScriptType- the type of the source scripttargetLanguageType- the type of the target languagetargetScriptType- the type of the target script- Returns:
trueif the given source and target translation is supported,falseotherwise- Throws:
NullArgumentException-sourceLanguageType, sourceScriptType, targetLanguageTypeortargetScriptTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getLanguageTypesForSource
Gets the list of target language types for a given source language type.- Parameters:
sourceLanguageType- the type of the source languagesourceScriptType- the type of the source script- Returns:
- the list of supported types for the given source language type
- Throws:
NullArgumentException-sourceLanguageTypeisnull- 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
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-languageTypeisnull- Compliance:
mandatory- This method must be implemented.
-
supportsNumericFormatTypes
Tests if a given numeric format type is supported.- Parameters:
numericFormatType- the type of the numeric format- Returns:
trueif the given numeric format type is supported,falseotherwise- Throws:
NullArgumentException-numericFormatTypeisnull- 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 calendartimeType- the type of the time systemdateFormatType- the type of the output date formattimeFormatType- the type of the output time format- Returns:
trueif formatting with the given types is supported,falseotherwise- Throws:
NullArgumentException-calendarType, calendarFormatType, timeType, ortimeFormatTypeisnull- 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
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-calendarTypeisnull- 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
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-timeTypeisnull- Compliance:
mandatory- This method must be implemented.
-
supportsCurrencyTypesForFormatting
Tests if a given currency formatting is supported.- Parameters:
currencyType- the type of the currencynumericFormatType- the type of the output currency format- Returns:
trueif formatting with the given types is supported,falseotherwise- Throws:
NullArgumentException-currencyTypeornumericFormatTypeisnull- 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
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-currencyTypeisnull- Compliance:
mandatory- This method must be implemented.
-
supportsCoordinateTypesForFormatting
Tests if a given coordinate formatting is supported.- Parameters:
coordinateType- the type of the coordinatecoordinateFormatType- the type of the output coordinate format- Returns:
trueif formatting with the given types is supported,falseotherwise- Throws:
NullArgumentException-cooridinateTypeorcoodinateFormatTypeisnull- 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
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-coordinaterTypeisnull- Compliance:
mandatory- This method must be implemented.
-
supportsUnitTypesForConversion
Tests if a given measure conversion is supported.- Parameters:
sourceUnitType- the type of the source measuretargetUnitType- the type of the target measure- Returns:
trueif the given source and target conversion is supported,falseotherwise- Throws:
NullArgumentException-sourceUnitTypeortargetUnitTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getUnitTypesForSource
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-sourceUnitTypeisnull- 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
Tests if a given currency conversion is supported.- Parameters:
sourceCurrencyType- the type of the source currencytargetCurrencyType- the type of the target currency- Returns:
trueif the given source and target conversion is supported,falseotherwise- Throws:
NullArgumentException-sourceCurrencyTypeortargetCurrencyTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCurrencyTypesForSource
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-sourceCurrencyTypeisnull- 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
Tests if a given calendar conversion is supported.- Parameters:
sourceCalendarType- the type of the source calendartargetCalendarType- the type of the target calendar- Returns:
trueif the given source and target conversion is supported,falseotherwise- Throws:
NullArgumentException-sourceCalendarTypeortargetCalendarTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCalendarTypesForSource
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-sourceCalendarTypeisnull- 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
Tests if a given time conversion is supported.- Parameters:
sourceTimeType- the type of the source timetargetTimeType- the type of the target time- Returns:
trueif the given source and target conversion is supported,falseotherwise- Throws:
NullArgumentException-sourceTimeTypeortargetTimeTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getTimeTypesForSource
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-sourceTimeTypeisnull- 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
Gets the list of time types supported for a given calendar type where they are both used in aDateTime.- Parameters:
calendarType- the type of the calendar- Returns:
- the list of supported time types
- Throws:
NullArgumentException-calendarTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCalendarTypesForTimeType
Gets the list of calendar types supported for a given time type where they are both used in aDateTime.- Parameters:
timeType- the type of the time system- Returns:
- the list of supported calendar types
- Throws:
NullArgumentException-timeTypeisnull- Compliance:
mandatory- This method must be implemented.
-
supportsCalendarTimeTypes
Tests if a given calendar and time type are used together in aDateTime.- Parameters:
calendarType- the type of the calendartimeType- the type of the time system- Returns:
trueif the given calendar and time types are supported,falseotherwise- Throws:
NullArgumentException-calendarTypeortimeTypeisnull- Compliance:
mandatory- This method must be implemented.
-
supportsCoordinateTypesForConversion
Tests if a given coordinate type for conversion is supported.- Parameters:
sourceCoordinateType- the type of the source coordinatetargetCoordinateType- the type of the target coordinate- Returns:
trueif the given source and target conversion is supported,falseotherwise- Throws:
NullArgumentException-sourceCoordinateTypeortargetCoordinateTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCoordinateTypesForSource
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-sourceCoordinateTypeisnull- 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 recordtargetSpatialUnitRecordType- the type of the target spatial unit record- Returns:
trueif the given source and target conversion is supported,falseotherwise- Throws:
NullArgumentException-sourceSpatialUnitRecordTypeortargetSpatialUnitRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getSpatialUnitRecordTypesForSource
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-sourceSpatialUnitRecordTypeisnull- 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
Tests if a given format conversion is supported.- Parameters:
sourceFormatType- the type of the source formattargetFormatType- the type of the target format- Returns:
trueif the given source and target conversion is supported,falseotherwise- Throws:
NullArgumentException-sourceFormatTypeortargetFormatTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getFormatTypesForSource
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-sourceFormatTypeisnull- 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.
-