OSID Specifications
locale package
Version 3.1.0
locale package
Version 3.1.0
| Interface | osid.locale.TranslationAdminSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.locale.LocaleManager | ||
osid.locale.LocaleProxyManager | |||
| Description |
This session defines methods to translate and format text between a source and target locale. | ||
| Method | getSourceLanguageType | ||
| Description |
Gets the source language used in this session. | ||
| Return | osid.type.Type | the source language | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSourceScriptType | ||
| Description |
Gets the source script used in this session. | ||
| Return | osid.type.Type | the source script | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTargetLanguageType | ||
| Description |
Gets the target language used in this session. | ||
| Return | osid.type.Type | the target language | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTargetScriptType | ||
| Description |
Gets the target script used in this session. | ||
| Return | osid.type.Type | the target script | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canUpdateTranslation | ||
| Description |
Tests if this user can update localization strings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a
| ||
| Return | boolean | false if changing translation is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addTranslation | ||
| Description |
Adds or updates a string translation. | ||
| Parameters | string | sourceText | the source string |
string | targetText | the translated string | |
| Errors | NULL_ARGUMENT | sourceText or targetText is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeTranslation | ||
| Description |
Removes a translation. | ||
| Parameters | string | sourceText | the source string |
| Errors | NULL_ARGUMENT | sourceText is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |