| Interface | osid.checklist.ChecklistSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing checklist searches. | ||
| Method | searchAmongChecklists | ||
| Description |
Execute this search among the given list of checklists. | ||
| Parameters | osid.id.IdList | checklistIds | list of checklists |
| Errors | NULL_ARGUMENT | checklistIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderChecklistResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.checklist.ChecklistSearchOrder | checklistSearchOrder | checklist search order |
| Errors | NULL_ARGUMENT | checklistSearchOrder is null | |
| UNSUPPORTED | checklistSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getChecklistSearchRecord | ||
| Description |
Gets the checklist search record corresponding to the
given checklist search record | ||
| Parameters | osid.type.Type | checklistSearchRecordType | a checklist search record type |
| Return | osid.checklist.records.ChecklistSearchRecord | the checklist search record | |
| Errors | NULL_ARGUMENT | checklistSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(checklistSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |