| Interface | osid.lexicon.PressSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.lexicon.PressSearchSession | ||
| Description |
The search interface for governing press searches. | ||
| Method | searchAmongPresses | ||
| Description |
Execute this search among the given list of presses. | ||
| Parameters | osid.id.IdList | pressIds | list of presses |
| Errors | NULL_ARGUMENT | pressIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderPressResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.lexicon.PressSearchOrder | pressSearchOrder | press search order |
| Errors | NULL_ARGUMENT | pressSearchOrder is null | |
| UNSUPPORTED | pressSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressSearchRecord | ||
| Description |
Gets the press search record corresponding to the given
press search record | ||
| Parameters | osid.type.Type | pressSearchRecordType | an press search record type |
| Return | osid.lexicon.records.PressSearchRecord | the press search 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. | |