Interface TranslationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TranslationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	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.
String	getTranslation(String string)	Translates the given string into the target language.
String	translateString(String string, String defaultString)	Translates the given string into the target language.
String[]	translateStrings(String[] strings, String[] defaultStrings)	Translates the given strings into the target language.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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

String getTranslation(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

String translateString(String string,
 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

String[] translateStrings(String[] strings,
 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.