| Interface | osid.lexicon.TextSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.lexicon.LexiconManager | ||
osid.lexicon.LexiconProxyManager | |||
| Description |
This session defines methods for retrieving
| ||
| Method | getPressId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Press Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPress | ||
| Description |
Gets the | ||
| Return | osid.lexicon.Press | the press | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canGetText | ||
| 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 | ||
| Return | boolean | false if text methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | text | ||
| Description |
Gets a | ||
| Parameters | osid.id.Id | textId | the Id of the text |
object[] | arguments | the arguments | |
| Return | osid.locale.DisplayText | the returned text | |
| Errors | INVALID_ARGUMENT | arguments do not match parameters | |
| NOT_FOUND | textId not found | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |