OSID - osid.locale.LocaleProfile Service Interface Definition

Interface	osid.locale.LocaleProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.locale.LocaleManager`
Implemented By	`osid.locale.LocaleProxyManager`
Description	The locale profile describes the interoperability of locale services.
Method	supportsVisibleFederation
Description	Tests if visible federation is supported.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTranslation
Description	Tests if translation is supported.
Return	`boolean`		`true` if translation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTranslationAdmin
Description	Tests if translation administration is supported.
Return	`boolean`		`true` if translation administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNumericFormatting
Description	Tests if numeric formatting is supported.
Return	`boolean`		`true` if numeric formatting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarFormatting
Description	Tests if calendar formatting is supported.
Return	`boolean`		`true` if calendar formatting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCurrencyFormatting
Description	Tests if currency formatting is supported.
Return	`boolean`		`true` if currency formatting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCoordinateFormatting
Description	Tests if coordinate formatting is supported.
Return	`boolean`		`true` if coordinate formatting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsUnitConversion
Description	Tests if unit conversion is supported.
Return	`boolean`		`true` if unit conversion is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCurrencyConversion
Description	Tests if currency conversion is supported.
Return	`boolean`		`true` if currency conversion is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarConversion
Description	Tests if calendar conversion is supported.
Return	`boolean`		`true` if calendar conversion is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCoordinateConversion
Description	Tests if coordnate conversion is supported.
Return	`boolean`		`true` if coordinate conversion is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpatialUnitConversion
Description	Tests if spatial unit conversion is supported.
Return	`boolean`		`true` if spatial unit conversion is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFormatConversion
Description	Tests if format conversion is supported.
Return	`boolean`		`true` if format conversion is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarInfo
Description	Tests if a calendar informational service is supported.
Return	`boolean`		`true` if calendar info is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLanguageTypesForTranslation
Description	Tests if a given language translation is supported.
Parameters	`osid.type.Type`	`sourceLanguageType`	the type of the source language
	`osid.type.Type`	`sourceScriptType`	the type of the source script
	`osid.type.Type`	`targetLanguageType`	the type of the target language
	`osid.type.Type`	`targetScriptType`	the type of the target script
Return	`boolean`		`true` if the given source and target translation is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceLanguageType, sourceScriptType, targetLanguageType` or `targetScriptType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLanguageTypesForSource
Description	Gets the list of target language types for a given source language type.
Parameters	`osid.type.Type`	`sourceLanguageType`	the type of the source language
Parameters	`osid.type.Type`	`sourceScriptType`	the type of the source script
Return	`osid.type.TypeList`		the list of supported types for the given source language type
Errors	NULL_ARGUMENT		`sourceLanguageType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceLanguageTypes
Description	Gets all the source language types supported.
Return	`osid.type.TypeList`		the list of supported language types
Compliance	`mandatory`		This method must be implemented.
Method	getScriptTypesForLanguageType
Description	Gets the list of script types available for a given language type.
Parameters	`osid.type.Type`	`languageType`	the type of the language
Return	`osid.type.TypeList`		the list of supported script types for the given language type
Errors	NULL_ARGUMENT		`languageType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsNumericFormatTypes
Description	Tests if a given numeric format type is supported.
Parameters	`osid.type.Type`	`numericFormatType`	the type of the numeric format
Return	`boolean`		`true` if the given numeric format type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`numericFormatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getNumericFormatTypes
Description	Gets all the numeric format types supported.
Return	`osid.type.TypeList`		the list of supported numeric format types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarTypesForFormatting
Description	Tests if a given calendaring formatting is supported.
Parameters	`osid.type.Type`	`calendarType`	the type of the calendar
	`osid.type.Type`	`timeType`	the type of the time system
	`osid.type.Type`	`dateFormatType`	the type of the output date format
	`osid.type.Type`	`timeFormatType`	the type of the output time format
Return	`boolean`		`true` if formatting with the given types is supported, `false` otherwise
Errors	NULL_ARGUMENT		`calendarType, calendarFormatType, timeType`, or `timeFormatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarTypesForFormatting
Description	Gets all the calendar types for which formats are available.
Return	`osid.type.TypeList`		the list of calendar types
Compliance	`mandatory`		This method must be implemented.
Method	getDateFormatTypesForCalendarType
Description	Gets the list of date format types for a given calendar type.
Parameters	`osid.type.Type`	`calendarType`	the type of the calendar
Return	`osid.type.TypeList`		the list of supported date format types
Errors	NULL_ARGUMENT		`calendarType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeTypesForFormatting
Description	Gets all the time types for which formatting is available.
Return	`osid.type.TypeList`		the list of time types
Compliance	`mandatory`		This method must be implemented.
Method	getTimeFormatTypesForTimeType
Description	Gets the list of time format types for a given time type.
Parameters	`osid.type.Type`	`timeType`	the type of the time
Return	`osid.type.TypeList`		the list of supported time format types
Errors	NULL_ARGUMENT		`timeType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCurrencyTypesForFormatting
Description	Tests if a given currency formatting is supported.
Parameters	`osid.type.Type`	`currencyType`	the type of the currency
Parameters	`osid.type.Type`	`numericFormatType`	the type of the output currency format
Return	`boolean`		`true` if formatting with the given types is supported, `false` otherwise
Errors	NULL_ARGUMENT		`currencyType` or `numericFormatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCurrencyTypesForFormatting
Description	Gets all the currency types for which formatting is available.
Return	`osid.type.TypeList`		the list of currency types
Compliance	`mandatory`		This method must be implemented.
Method	getCurrencyFormatTypesForCurrencyType
Description	Gets the list of currency format types for a given currency type.
Parameters	`osid.type.Type`	`currencyType`	the type of the currency
Return	`osid.type.TypeList`		the list of supported currency format types
Errors	NULL_ARGUMENT		`currencyType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCoordinateTypesForFormatting
Description	Tests if a given coordinate formatting is supported.
Parameters	`osid.type.Type`	`coordinateType`	the type of the coordinate
Parameters	`osid.type.Type`	`coordinateFormatType`	the type of the output coordinate format
Return	`boolean`		`true` if formatting with the given types is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cooridinateType` or `coodinateFormatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinateTypesForFormatting
Description	Gets all the coordinate types for which formatting is available.
Return	`osid.type.TypeList`		the list of coordinate types
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinateFormatTypesForCoordinateType
Description	Gets the list of coordinate format types for a given coordinate type.
Parameters	`osid.type.Type`	`coordinateType`	the type of the coordinate
Return	`osid.type.TypeList`		the list of supported coordinate format types
Errors	NULL_ARGUMENT		`coordinaterType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsUnitTypesForConversion
Description	Tests if a given measure conversion is supported.
Parameters	`osid.type.Type`	`sourceUnitType`	the type of the source measure
Parameters	`osid.type.Type`	`targetUnitType`	the type of the target measure
Return	`boolean`		`true` if the given source and target conversion is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceUnitType` or `targetUnitType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getUnitTypesForSource
Description	Gets the list of target measure types for a given source measure type.
Parameters	`osid.type.Type`	`sourceUnitType`	the type of the source measure
Return	`osid.type.TypeList`		the list of supported target measure types
Errors	NULL_ARGUMENT		`sourceUnitType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceUnitTypes
Description	Gets all the source unit types supported.
Return	`osid.type.TypeList`		the list of supported source unit types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCurrencyTypesForConversion
Description	Tests if a given currency conversion is supported.
Parameters	`osid.type.Type`	`sourceCurrencyType`	the type of the source currency
Parameters	`osid.type.Type`	`targetCurrencyType`	the type of the target currency
Return	`boolean`		`true` if the given source and target conversion is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceCurrencyType` or `targetCurrencyType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCurrencyTypesForSource
Description	Gets the list of target currency types for a given source currency type.
Parameters	`osid.type.Type`	`sourceCurrencyType`	the type of the source currency
Return	`osid.type.TypeList`		the list of supported currency types
Errors	NULL_ARGUMENT		`sourceCurrencyType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceCurrencyTypes
Description	Gets the list of source currency types.
Return	`osid.type.TypeList`		the list of supported source currency types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarTypesForConversion
Description	Tests if a given calendar conversion is supported.
Parameters	`osid.type.Type`	`sourceCalendarType`	the type of the source calendar
Parameters	`osid.type.Type`	`targetCalendarType`	the type of the target calendar
Return	`boolean`		`true` if the given source and target conversion is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceCalendarType` or `targetCalendarType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarTypesForSource
Description	Gets the list of target calendar types for a given source calendar type.
Parameters	`osid.type.Type`	`sourceCalendarType`	the type of the source calendar
Return	`osid.type.TypeList`		the list of supported calendar types
Errors	NULL_ARGUMENT		`sourceCalendarType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceCalendarTypes
Description	Gets the list of source calendar types.
Return	`osid.type.TypeList`		the list of supported source calendar types
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimeTypesForConversion
Description	Tests if a given time conversion is supported.
Parameters	`osid.type.Type`	`sourceTimeType`	the type of the source time
Parameters	`osid.type.Type`	`targetTimeType`	the type of the target time
Return	`boolean`		`true` if the given source and target conversion is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceTimeType` or `targetTimeType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeTypesForSource
Description	Gets the list of target time types for a given source time type.
Parameters	`osid.type.Type`	`sourceTimeType`	the type of the source time
Return	`osid.type.TypeList`		the list of supported time types
Errors	NULL_ARGUMENT		`sourceTimeType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceTimeTypes
Description	Gets the list of source time types.
Return	`osid.type.TypeList`		the list of supported source time types
Compliance	`mandatory`		This method must be implemented.
Method	getTimeTypesForCalendarType
Description	Gets the list of time types supported for a given calendar type where they are both used in a `DateTime`.
Parameters	`osid.type.Type`	`calendarType`	the type of the calendar
Return	`osid.type.TypeList`		the list of supported time types
Errors	NULL_ARGUMENT		`calendarType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarTypesForTimeType
Description	Gets the list of calendar types supported for a given time type where they are both used in a `DateTime`.
Parameters	`osid.type.Type`	`timeType`	the type of the time system
Return	`osid.type.TypeList`		the list of supported calendar types
Errors	NULL_ARGUMENT		`timeType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarTimeTypes
Description	Tests if a given calendar and time type are used together in a `DateTime`.
Parameters	`osid.type.Type`	`calendarType`	the type of the calendar
Parameters	`osid.type.Type`	`timeType`	the type of the time system
Return	`boolean`		`true` if the given calendar and time types are supported, `false` otherwise
Errors	NULL_ARGUMENT		`calendarType` or `timeType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCoordinateTypesForConversion
Description	Tests if a given coordinate type for conversion is supported.
Parameters	`osid.type.Type`	`sourceCoordinateType`	the type of the source coordinate
Parameters	`osid.type.Type`	`targetCoordinateType`	the type of the target coordinate
Return	`boolean`		`true` if the given source and target conversion is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceCoordinateType` or `targetCoordinateType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinateTypesForSource
Description	Gets the list of target coordinate types for a given source coordinate type.
Parameters	`osid.type.Type`	`sourceCoordinateType`	the type of the source coordinate
Return	`osid.type.TypeList`		the list of supported target coordinate types
Errors	NULL_ARGUMENT		`sourceCoordinateType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceCoordinateTypes
Description	Gets the list of source coordinate types.
Return	`osid.type.TypeList`		the list of supported source coordinate types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpatialUnitRecordTypesForConversion
Description	Tests if a given spatial unit conversion is supported.
Parameters	`osid.type.Type`	`sourceSpatialUnitRecordType`	the type of the source spatial unit record
Parameters	`osid.type.Type`	`targetSpatialUnitRecordType`	the type of the target spatial unit record
Return	`boolean`		`true` if the given source and target conversion is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceSpatialUnitRecordType` or `targetSpatialUnitRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSpatialUnitRecordTypesForSource
Description	Gets the list of target spatial unit types for a given source spatial unit type.
Parameters	`osid.type.Type`	`sourceSpatialUnitRecordType`	the type of the source spatial unit record
Return	`osid.type.TypeList`		the list of supported target spatial unit record types
Errors	NULL_ARGUMENT		`sourceSpatialUnitRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceSpatialUnitRecordTypes
Description	Gets the list of source spatial unit record types.
Return	`osid.type.TypeList`		the list of supported source spatial unit record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFormatTypesForConversion
Description	Tests if a given format conversion is supported.
Parameters	`osid.type.Type`	`sourceFormatType`	the type of the source format
Parameters	`osid.type.Type`	`targetFormatType`	the type of the target format
Return	`boolean`		`true` if the given source and target conversion is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sourceFormatType` or `targetFormatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFormatTypesForSource
Description	Gets the list of target format types for a given source spatial unit type.
Parameters	`osid.type.Type`	`sourceFormatType`	the type of the source format
Return	`osid.type.TypeList`		the list of supported target format types
Errors	NULL_ARGUMENT		`sourceFormatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceFormatTypes
Description	Gets the list of source format types.
Return	`osid.type.TypeList`		the list of supported source format types
Compliance	`mandatory`		This method must be implemented.