OSID Logo
OSID Specifications
lexicon package
Version 3.0.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.Idthe Press Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPress
Description

Gets the Press associated with this session.

Returnosid.lexicon.Pressthe press
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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.

Returnbooleanfalse if text methods are not authorized, true otherwise
CompliancemandatoryThis 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.IdtextIdthe Id of the text
object[]argumentsthe arguments
Returnosid.locale.DisplayTextthe returned text
ErrorsINVALID_ARGUMENTarguments do not match parameters
NOT_FOUNDtextId not found
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.