org.osid.locale

Interface TranslationAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface TranslationAdminSession
extends OsidSession

This session defines methods to translate and format text between a source and target locale.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSourceLanguageType

Type getSourceLanguageType()

Gets the source language used in this session.

Returns:

the source language

Compliance:

mandatory - This method must be implemented.

getSourceScriptType

Type getSourceScriptType()

Gets the source script used in this session.

Returns:

the source script

Compliance:

mandatory - This method must be implemented.

getTargetLanguageType

Type getTargetLanguageType()

Gets the target language used in this session.

Returns:

the target language

Compliance:

mandatory - This method must be implemented.

getTargetScriptType

Type getTargetScriptType()

Gets the target script used in this session.

Returns:

the target script

Compliance:

mandatory - This method must be implemented.

canUpdateTranslation

boolean canUpdateTranslation()

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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returns:

false if changing translation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addTranslation

void addTranslation(java.lang.String sourceText,
                  java.lang.String targetText)
                    throws OperationFailedException,
                           PermissionDeniedException

Adds or updates a string translation.

Parameters:

sourceText - the source string

targetText - the translated string

Throws:

NullArgumentException - sourceText or targetText is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeTranslation

void removeTranslation(java.lang.String sourceText)
                       throws OperationFailedException,
                              PermissionDeniedException

Removes a translation.

Parameters:

sourceText - the source string

Throws:

NullArgumentException - sourceText is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.