public interface FormatConversionSession extends OsidSession
This session defines methods to convert text formats.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Type getSourceFormatType()
mandatory
- This method must be implemented. Type getTargetFormatType()
mandatory
- This method must be implemented. boolean canConvertFormats()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations. false
if conversion methods are not authorized,
true
otherwisemandatory
- This method must be implemented. java.lang.String convertFormat(java.lang.String sourceText) throws OperationFailedException, PermissionDeniedException
sourceText
- the string to convertInvalidArgumentException
- sourceText
not of source formatNullArgumentException
- sourceText
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. java.lang.String[] convertFormats(java.lang.String[] sourceTexts) throws OperationFailedException, PermissionDeniedException
sourceTexts
- the strings to convertInvalidArgumentException
- a sourceText not of
source format
NullArgumentException
- sourceTexts
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.