org.osid.locale

Interface FormatConversionSession

All Superinterfaces:

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

public interface FormatConversionSession
extends OsidSession

This session defines methods to convert text formats.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canConvertFormats() Tests if this user can perform text format.
java.lang.String	convertFormat(java.lang.String sourceText) Converts a format.
java.lang.String[]	convertFormats(java.lang.String[] sourceTexts) Converts formats.
Type	getSourceFormatType() Gets the source format type used in this session.
Type	getTargetFormatType() Gets the target format type used in this session.

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

getSourceFormatType

Type getSourceFormatType()

Gets the source format type used in this session.

Returns:

the source text format type

Compliance:

mandatory - This method must be implemented.

getTargetFormatType

Type getTargetFormatType()

Gets the target format type used in this session.

Returns:

the target text formattype

Compliance:

mandatory - This method must be implemented.

canConvertFormats

boolean canConvertFormats()

Tests if this user can perform text format. 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 conversion methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

convertFormat

java.lang.String convertFormat(java.lang.String sourceText)
                               throws OperationFailedException,
                                      PermissionDeniedException

Converts a format.

Parameters:

sourceText - the string to convert

Returns:

the resulting string

Throws:

InvalidArgumentException - sourceText not of source format

NullArgumentException - sourceText is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

convertFormats

java.lang.String[] convertFormats(java.lang.String[] sourceTexts)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Converts formats.

Parameters:

sourceTexts - the strings to convert

Returns:

the resulting strings

Throws:

InvalidArgumentException - a sourceText not of source format

NullArgumentException - sourceTexts is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.