| Interface | osid.control.SystemSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing system searches. | ||
| Method | searchAmongSystems | ||
| Description |
Execute this search among the given list of systems. | ||
| Parameters | osid.id.IdList | systemIds | list of systems |
| Errors | NULL_ARGUMENT | systemIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderSystemResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.control.SystemSearchOrder | systemSearchOrder | system search order |
| Errors | NULL_ARGUMENT | systemSearchOrder is null | |
| UNSUPPORTED | systemSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getSystemSearchRecord | ||
| Description |
Gets the system search record corresponding to the
given system search record | ||
| Parameters | osid.type.Type | systemSearchRecordType | a system search record type |
| Return | osid.control.records.SystemSearchRecord | the system search record | |
| Errors | NULL_ARGUMENT | systemSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(systemSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |