Interface FormatConversionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface FormatConversionSession
extends OsidSession

This session defines methods to convert text formats.

Method Summary

Modifier and Type	Method	Description
boolean	canConvertFormats()	Tests if this user can perform text format.
String	convertFormat(String sourceText)	Converts a format.
String[]	convertFormats(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 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

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 format type

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

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

String[] convertFormats(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.