| Interface | osid.lexicon.PressSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.lexicon.PressSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getPresses | ||
| Description |
Gets the press list resulting from a search. | ||
| Return | osid.lexicon.PressList | the press list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.lexicon.PressQueryInspector | the press query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressSearchResultsRecord | ||
| Description |
Gets the press search results record corresponding to
the given press search record | ||
| Parameters | osid.type.Type | pressSearchRecordType | an press search record type |
| Return | osid.lexicon.records.PressSearchResultsRecord | the press search results record | |
| Errors | NULL_ARGUMENT | pressSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(pressSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |