OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.TextSession
Implementsosid.OsidSession
Used Byosid.lexicon.LexiconManager
osid.lexicon.LexiconProxyManager
Description

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

MethodgetPressId
Description

Gets the Press Id associated with this session.

Returnosid.id.Id the Press Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetPress
Description

Gets the Press associated with this session.

Returnosid.lexicon.Press the press
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanGetText
Description

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.

Returnboolean false if text methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
Methodtext
Description

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

Parametersosid.id.IdtextId the Id of the text
object[]arguments the arguments
Returnosid.locale.DisplayText the returned text
ErrorsINVALID_ARGUMENT arguments do not match parameters
NOT_FOUND textId not found
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.