OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
room package
Version 3.0.0
Release Candidate Preview
| Interface | osid.room.CampusSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCampuses | ||
| Description |
Gets the campus list resulting from a search. | ||
| Return | osid.room.CampusList | the campus list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCampusQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.room.CampusQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCampusSearchResultsRecord | ||
| Description |
Gets the campus search results record corresponding to the given campus search record Type. This method must be used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | campusSearchRecordType | a campus search record type |
| Return | osid.room.records.CampusSearchResultsRecord | the campus search results 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. | |