public interface TranslationAdminSession extends OsidSession
This session defines methods to translate and format text between a source and target locale.
Modifier and Type | Method and Description |
---|---|
void |
addTranslation(java.lang.String sourceText,
java.lang.String targetText)
Adds or updates a string translation.
|
boolean |
canUpdateTranslation()
Tests if this user can update localization strings.
|
Type |
getSourceLanguageType()
Gets the source language used in this session.
|
Type |
getSourceScriptType()
Gets the source script used in this session.
|
Type |
getTargetLanguageType()
Gets the target language used in this session.
|
Type |
getTargetScriptType()
Gets the target script used in this session.
|
void |
removeTranslation(java.lang.String sourceText)
Removes a translation.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Type getSourceLanguageType()
mandatory
- This method must be implemented. Type getSourceScriptType()
mandatory
- This method must be implemented. Type getTargetLanguageType()
mandatory
- This method must be implemented. Type getTargetScriptType()
mandatory
- This method must be implemented. boolean canUpdateTranslation()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer notification operations. false
if changing translation is not
authorized, true
otherwisemandatory
- This method must be implemented. void addTranslation(java.lang.String sourceText, java.lang.String targetText) throws OperationFailedException, PermissionDeniedException
sourceText
- the source string
targetText
- the translated stringNullArgumentException
- sourceText
or
targetText
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeTranslation(java.lang.String sourceText) throws OperationFailedException, PermissionDeniedException
sourceText
- the source string
NullArgumentException
- sourceText
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.