Interface | osid.rules.check.AgendaSearchSession | ||
---|---|---|---|
Implements | osid.rules.check.AgendaQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Agendas may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getAgendaSearch | ||
Description |
Gets an agenda search. | ||
Return | osid.rules.check.AgendaSearch | the agenda search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgendaSearchOrder | ||
Description |
Gets an agenda search order. The | ||
Return | osid.rules.check.AgendaSearchOrder | the agenda search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgendasBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.rules.check.AgendaQuery | agendaQuery | the agenda query |
osid.rules.check.AgendaSearch | agendaSearch | the agenda search | |
Return | osid.rules.check.AgendaSearchResults | the agenda search results | |
Errors | NULL_ARGUMENT | agendaQuery or agendaSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | agendaQuery or agendaSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgendaQueryFromInspector | ||
Description |
Gets an agenda query from an inspector. The inspector
is available from an | ||
Parameters | osid.rules.check.AgendaQueryInspector | agendaQueryInspector | an agenda query inspector |
Return | osid.rules.check.AgendaQuery | the agenda query | |
Errors | NULL_ARGUMENT | agendaQueryInspector is null | |
UNSUPPORTED | agendaQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |