OSID Specifications
dictionary package
Version 3.1.0
dictionary package
Version 3.1.0
| Interface | osid.dictionary.EntryQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Implemented By | osid.dictionary.EntrySearchSession | ||
| Used By | osid.dictionary.DictionaryManager | ||
osid.dictionary.DictionaryProxyManager | |||
| Description |
This session provides methods for searching among entries.
The search query is constructed using the
| ||
| Method | getDictionaryId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Dictionary Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDictionary | ||
| Description |
Gets the | ||
| Return | osid.dictionary.Dictionary | the Dictionary associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSearchEntries | ||
| Description |
Tests if this user can perform dictionary entry
searches. 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 search methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useFederatedDictionaryView | ||
| Description |
Federates the view for methods in this session. A federated view will include entries from descendant dictionaries in the catalog hierarchy. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedDictionaryView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts notifications for entries to this dictionary only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getEntryQuery | ||
| Description |
Gets an entry query. | ||
| Return | osid.dictionary.EntryQuery | the entry query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntriesByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.dictionary.EntryQuery | entryQuery | the entry query |
| Return | osid.dictionary.EntryList | the returned EntryList | |
| Errors | NULL_ARGUMENT | entryQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | entryQuery is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |