OSID - osid.locale.LocaleManager Service Interface Definition

Interface	osid.locale.LocaleManager
Implements	`osid.OsidManager`
Implements	`osid.locale.LocaleProfile`
Description	The locale manager provides access to locale sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `TranslationSession:` a session translate strings `TranslationAdminSession: a` session to update the string translations for a locale `NumericFormattingSession:` a session for formatting and parsing numbers `CalendarFormattingSession:` a session for formatting and parsing dates and times `CurrencyFormattingSession` : a session for formatting and parsing currency amounts `CoordinateFormattingSession:` a session for formatting and parsing coordinates `UnitConversionSession:` a session to convert measurement units `CurrencyConversionSession:` a session to convert currency `CalendarConversionSession:` a session to convert dates across calendars `CoordinateConversionSession:` a session to convert coordinate systems `SpatialUnitConversionSession:` a session to convert spatial units `FormatConversionSession:` a session to convert text formats `CalendarInfoSession:` a session for examining calendaring and time systems
Method	getTranslationSession
Description	Gets an `OsidSession` associated with the language translation service.
Return	`osid.locale.TranslationSession`		a `TranslationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTranslation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTranslation()` is `true.`
Method	getTranslationSessionForType
Description	Gets an `OsidSession` associated with the language translation service and the given language and script types.
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	`osid.locale.TranslationSession`		a `TranslationSession`
Errors	NULL_ARGUMENT		`sourceLanguageType, sourceScriptType, targetLanguageType` or `targetScriptType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTranslation()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsLanguageTypesForTranslation(sourceLanguageType, sourceScriptType, targetLanguageType, targetScriptType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsTranslation()` and `supportsVisibleFederation()` are `true.`
Method	getTranslationAdminSession
Description	Gets a language translation administration service for updating a locale dictionary.
Return	`osid.locale.TranslationAdminSession`		a `TranslationAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTranslationAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTranslationAdmin()` is `true.`
Method	getTranslationAdminSessionForType
Description	Gets a language trabslation administration service for updating a locale dictionary using the given language and script types.
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	`osid.locale.TranslationAdminSession`		a `TranslationAdminSession`
Errors	NULL_ARGUMENT		`sourceLanguageType, sourceScriptType, targetLanguageType` or `targetScriptType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTranslationAdmin()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsLanguageTypesForTranslation(sourceLanguageType, sourceScriptType, targetLanguageType, targetScriptType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsTranslationAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getNumericFormattingSession
Description	Gets an `OsidSession` associated with the numeric formatting service.
Return	`osid.locale.NumericFormattingSession`		a `NumericFormattingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsNumericFormatting()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNumericFormatting()` is `true.`
Method	getNumericFormattingSessionForType
Description	Gets an `OsidSession` associated with the numeric formatting service and the given numeric format type.
Parameters	`osid.type.Type`	`numericFormatType`	the type of the numeric format
Return	`osid.locale.NumericFormattingSession`		a `NumericFormattingSession`
Errors	NULL_ARGUMENT		`numericFormatType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsNumericFormatting()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsNumericFormatType(numericFormatType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsNumericFormatting()` and `supportsVisibleFederation()` are `true.`
Method	getCalendarFormattingSession
Description	Gets an `OsidSession` associated with the calendar formatting service.
Return	`osid.locale.CalendarFormattingSession`		a `CalendarFormattingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCalendarFormatting()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarFormatting()` is `true.`
Method	getCalendarFormattingSessionForType
Description	Gets an `OsidSession` associated with the calendar formatting service and the given calendar and time types.
Parameters	`osid.type.Type`	`calendarType`	the type of the calendar
	`osid.type.Type`	`calendarFormatType`	the type of the calendar format
	`osid.type.Type`	`timeType`	the type of the time system
	`osid.type.Type`	`timeFormatType`	the type of the time format
Return	`osid.locale.CalendarFormattingSession`		a `CalendarFormattingSession`
Errors	NULL_ARGUMENT		`calendarType, calendarFormatType, timeType` or `timeFormatType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCalendarFormatting()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsCalendarTypesForFormattinge(calendarType, calendarFormatType, timeType, timeFormatType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarFormatting()` and `supportsVisibleFederation()` are `true.`
Method	getCurrencyFormattingSession
Description	Gets an `OsidSession` associated with the currency formatting service.
Return	`osid.locale.CurrencyFormattingSession`		a `CurrencyFormattingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCurrencyFormatting()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCurrencyFormatting()` is `true.`
Method	getCurrencyFormattingSessionForType
Description	Gets an `OsidSession` associated with the currency formatting service and the given currency and numeric format types.
Parameters	`osid.type.Type`	`currencyType`	the type of the currency
Parameters	`osid.type.Type`	`numericFormatType`	the type of the numeric format
Return	`osid.locale.CurrencyFormattingSession`		a `CurrencyFormattingSession`
Errors	NULL_ARGUMENT		`currencyType` or `numericFormatType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCurrencyFormatting()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsCurrencyTypesForFomatting(currencyType, numericFormatType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsCurrencyFormatting()` and `supportsVisibleFederation()` are `true.`
Method	getCoordinateFormattingSession
Description	Gets an `OsidSession` associated with the coordinate formatting service.
Return	`osid.locale.CoordinateFormattingSession`		a `CoordinateFormattingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCoordinateFormatting()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCoordinateFormatting()` is `true.`
Method	getCoordinateFormattingSessionForType
Description	Gets an `OsidSession` associated with the coordinate formatting service and the given coordinate and format types.
Parameters	`osid.type.Type`	`coordinateType`	the type of the coordinate
Parameters	`osid.type.Type`	`coordinateFormatType`	the type of the coordinate format
Return	`osid.locale.CoordinateFormattingSession`		a `CoordinateFormattingSession`
Errors	NULL_ARGUMENT		`coordinateType` or `coordinateFormatType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCoordinateFormatting()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsCoordinateTypesForFomatting(coordinateType, coordinateFormatType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsCoordinateFormatting()` and `supportsVisibleFederation()` are `true.`
Method	getUnitConversionSession
Description	Gets a unit conversion session.
Return	`osid.locale.UnitConversionSession`		a `UnitConversionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsUnitConversion()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUnitConversion()` is `true.`
Method	getCurrencyConversionSession
Description	Gets a currency conversion session.
Return	`osid.locale.CurrencyConversionSession`		a `CurrencyConversionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCurrencyConversion()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCurrencyConversion()` is `true.`
Method	getCurrencyConversionSessionForType
Description	Gets an `OsidSession` associated with the currency conversion service and the given currency types.
Parameters	`osid.type.Type`	`sourceCurrencyType`	the type of the source currency
Parameters	`osid.type.Type`	`targetCurrencyType`	the type of the target currency
Return	`osid.locale.CurrencyConversionSession`		a `CurrencyConversionSession`
Errors	NULL_ARGUMENT		`sourceCurrencyType` or `targetCurrencyType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCurrencyConversion()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsCurrencyTypesForConversion(sourceCurrencyType, targetCurrencyType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsCurrencyConversion()` and `supportsVisibleFederation()` are `true.`
Method	getCalendarConversionSession
Description	Gets a calendar conversion session.
Return	`osid.locale.CalendarConversionSession`		a `CalendarConversionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCalendarConversion()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarConversion()` is `true.`
Method	getCalendarConversionSessionForType
Description	Gets an `OsidSession` associated with the calendar conversion service and the given calendar types.
Parameters	`osid.type.Type`	`sourceCalendarType`	the type of the source calendar
	`osid.type.Type`	`sourceTimeType`	the type of the source time
	`osid.type.Type`	`targetCalendarType`	the type of the target calendar
	`osid.type.Type`	`targetTimeType`	the type of the target time
Return	`osid.locale.CalendarConversionSession`		a `CalendarConversionSession`
Errors	NULL_ARGUMENT		`sourceCalendarType, sourceTimeType,` `targetCalendarType` or `targetTimeType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCalendarConversion()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsCalendarTypesForConversion(sourceCalendarType, targetCalendarType)` or `supportsTimeTypesForConversion(sourceTimeType, targetTimeType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarConversion()` and `supportsVisibleFederation()` are `true.`
Method	getCoordinateConversionSession
Description	Gets a coordinate conversion session.
Return	`osid.locale.CoordinateConversionSession`		a `CoordinateConversionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCoordinateConversion()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCoordinateConversion()` is `true.`
Method	getCoordinateConversionSessionForType
Description	Gets an `OsidSession` associated with the coordinate conversion service and the given coordinate types.
Parameters	`osid.type.Type`	`sourceCoordinateType`	the type of the source coordinate
Parameters	`osid.type.Type`	`targetCoordinateType`	the type of the target coordinate
Return	`osid.locale.CoordinateConversionSession`		a `CoordinateConversionSession`
Errors	NULL_ARGUMENT		`sourceCoordinateType` or `targetCoordinateType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCoordinateConversion()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsCoordinateRecordTypesForConversion(sourceCoordinateType, targetCoordinateType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsCoordinateConversion()` and `supportsVisibleFederation()` are `true.`
Method	getSpatialUnitConversionSession
Description	Gets a spatial unit conversion session.
Return	`osid.locale.SpatialUnitConversionSession`		a `SpatialUnitConversionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSpatialUnitConversion()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSpatialUnitConversion()` is `true.`
Method	getSpatialUnitConversionSessionForType
Description	Gets an `OsidSession` associated with the spatial unit conversion service and the given spatial unit record types.
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	`osid.locale.SpatialUnitConversionSession`		a `SpatialUnitConversionSession`
Errors	NULL_ARGUMENT		`sourceSpatialUnitRecordType` or `targetSpatialUnitRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSpatialUnitConversion()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsSpatialUnitRecordTypesForConversion(sourceSpatialUnitRecordType, targetSpatialUnitRecordType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsSpatialUnitConversion()` and `supportsVisibleFederation()` are `true.`
Method	getFormatConversionSession
Description	Gets a text format conversion session.
Return	`osid.locale.FormatConversionSession`		a `FormatConversionSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFormatConversion()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFormatConversion()` is `true.`
Method	getFormatConversionSessionForType
Description	Gets an `OsidSession` associated with the text format conversion service and the given format types.
Parameters	`osid.type.Type`	`sourceFormatType`	the type of the text format
Parameters	`osid.type.Type`	`targetFormatType`	the type of the text format
Return	`osid.locale.FormatConversionSession`		a `FormatConversionSession`
Errors	NULL_ARGUMENT		`sourceFormatType` or `targetFormatType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFormatConversion()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsFormatTypesForConversion(sourceFormatType, targetFormatRecordType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsFormatConversion()` and `supportsVisibleFederation()` are `true.`
Method	getCalendarInfoSession
Description	Gets a calendar informational session session.
Return	`osid.locale.CalendarInfoSession`		a `CalendarInfoSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCalendarInfo()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarInfo()` is `true.`
Method	getCalendarInfoSessionForType
Description	Gets an `OsidSession` associated with the calendar informational service and the given calendar and time types.
Parameters	`osid.type.Type`	`calendarType`	the type of the calendar
Parameters	`osid.type.Type`	`timeType`	the type of the time system
Return	`osid.locale.CalendarInfoSession`		a `CalendarInfoSession`
Errors	NULL_ARGUMENT		`calendarType` or `timeType` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCalendarType()` or `supportsVisibleFederation()` is `false`
	UNSUPPORTED		`supportsCalendarTimeTypes(calendarType, timeType)` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarInfo()` and `supportsVisibleFederation()` are `true.`