org.osid.locale

Interface TranslationSession

All Superinterfaces:

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

public interface TranslationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canTranslate() Tests if this user can perform language translations.
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.
java.lang.String	getTranslation(java.lang.String string) Translates the given string into the target language.
java.lang.String	translateString(java.lang.String string, java.lang.String defaultString) Translates the given string into the target language.
java.lang.String[]	translateStrings(java.lang.String[] strings, java.lang.String[] defaultStrings) Translates the given strings into the target language.

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.

canTranslate

boolean canTranslate()

Tests if this user can perform language translations. 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 lookup operations.

Returns:

false if translation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getTranslation

java.lang.String getTranslation(java.lang.String string)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Translates the given string into the target language.

Parameters:

string - the string to translate

Returns:

the translated string

Throws:

NotFoundException - no translation found

NullArgumentException - null argument provided

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

translateString

java.lang.String translateString(java.lang.String string,
                               java.lang.String defaultString)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Translates the given string into the target language.

Parameters:

string - the string to translate

defaultString - the default string if no translation available.

Returns:

the translated string or the given default value if no translation available.

Throws:

NullArgumentException - null argument provided

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

translateStrings

java.lang.String[] translateStrings(java.lang.String[] strings,
                                  java.lang.String[] defaultStrings)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Translates the given strings into the target language.

Parameters:

strings - the string to translate

defaultStrings - the default string if no translation available.

Returns:

the translated strings or the given default value if no translation available.

Throws:

NullArgumentException - null argument provided

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.