| Interface | osid.workflow.OfficeSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing office searches. | ||
| Method | searchAmongOffices | ||
| Description |
Execute this search among the given list of offices. | ||
| Parameters | osid.id.IdList | officeIds | list of offices |
| Errors | NULL_ARGUMENT | officeIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOfficeResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.workflow.OfficeSearchOrder | officeSearchOrder | office search order |
| Errors | NULL_ARGUMENT | officeSearchOrder is null | |
| UNSUPPORTED | officeSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfficeSearchRecord | ||
| Description |
Gets the office search record corresponding to the
given office search record | ||
| Parameters | osid.type.Type | officeSearchRecordType | a office search record type |
| Return | osid.workflow.records.OfficeSearchRecord | the office search record | |
| Errors | NULL_ARGUMENT | officeSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(officeSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |