Interface TextSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TextSession
extends OsidSession

This session defines methods for retrieving DisplayTexts for a Text and set of Parameter arguments.

Method Summary

Modifier and Type	Method	Description
boolean	canGetText()	Tests if this user can acquire text.
Press	getPress()	Gets the Press associated with this session.
Id	getPressId()	Gets the Press Id associated with this session.
DisplayText	text(Id textId, Object[] arguments)	Gets a DisplayText for a Text and set of Parameter arguments supplied in order of their input position.

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

getPressId

Id getPressId()

Gets the Press Id associated with this session.

Returns:

the Press Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPress

Press getPress()
        throws OperationFailedException,
PermissionDeniedException

Gets the Press associated with this session.

Returns:

the press

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canGetText

boolean canGetText()

Tests if this user can acquire text. 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 press that may not offer lookup operations to unauthorized users.

Returns:

false if text methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

text

DisplayText text(Id textId,
 Object[] arguments)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a DisplayText for a Text and set of Parameter arguments supplied in order of their input position.

Parameters:

textId - the Id of the text

arguments - the arguments

Returns:

the returned text

Throws:

InvalidArgumentException - arguments do not match parameters

NotFoundException - textId not found

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.