| Interface | osid.lexicon.PressSearchSession | ||
|---|---|---|---|
| Implements | osid.lexicon.PressQuerySession | ||
| Used By | osid.lexicon.LexiconManager | ||
osid.lexicon.LexiconProxyManager | |||
| Description |
This session provides methods for searching among
getPressesByQuery() is the basic search method
and returns a list of Presses . A more advanced
search may be performed with getPressesBySearch()
.It accepts a PressSearch in addition to the
query for the purpose of specifying additional options
affecting the entire search, such as ordering.
getPressesBySearch() returns a
PressSearchResults that can be used to access the
resulting PressList or be used to perform a
search within the result set through PressSearch
.
Presses may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getPressSearch | ||
| Description |
Gets an press search. | ||
| Return | osid.lexicon.PressSearch | the press search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressSearchOrder | ||
| Description |
Gets an press search order. The
| ||
| Return | osid.lexicon.PressSearchOrder | the press search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressesBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.lexicon.PressQuery | pressQuery | the press query |
osid.lexicon.PressSearch | pressSearch | the press search | |
| Return | osid.lexicon.PressSearchResults | the press search results | |
| Errors | NULL_ARGUMENT | pressQuery or pressSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | pressQuery or pressSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressQueryFromInspector | ||
| Description |
Gets an press query from an inspector. The inspector is
available from a | ||
| Parameters | osid.lexicon.PressQueryInspector | pressQueryInspector | an press query inspector |
| Return | osid.lexicon.PressQuery | the press query | |
| Errors | NULL_ARGUMENT | pressQueryInspector is null | |
| UNSUPPORTED | pressQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |