| Interface | osid.rules.check.AgendaSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getAgendas | ||
| Description |
Gets the agenda list resulting from a search. | ||
| Return | osid.rules.check.AgendaList | the agenda list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgendaQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.rules.check.AgendaQueryInspector | the agenda query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgendaSearchResultsRecord | ||
| Description |
Gets the agenda search results record corresponding to
the given agenda search record | ||
| Parameters | osid.type.Type | agendaSearchRecordType | an agenda search record type |
| Return | osid.rules.check.records.AgendaSearchResultsRecord | the agenda search results record | |
| Errors | NULL_ARGUMENT | agendaSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(agendaSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |