| Interface | osid.room.CampusSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing campus searches. | ||
| Method | searchAmongCampuses | ||
| Description |
Execute this search among the given list of campuses. | ||
| Parameters | osid.id.IdList | campusIds | list of campuses |
| Errors | NULL_ARGUMENT | campusIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCampusResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.room.CampusSearchOrder | campussearchOrder | campus search order |
| Errors | NULL_ARGUMENT | campussearchOrder is null | |
| UNSUPPORTED | campussearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCampusSearchRecord | ||
| Description |
Gets the campus search record corresponding to the
given campus search record | ||
| Parameters | osid.type.Type | campusSearchRecordType | a campus search record type |
| Return | osid.room.records.CampusSearchRecord | the campus search record | |
| Errors | NULL_ARGUMENT | campussearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(campussearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |