OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.ParticipantSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getParticipants | ||
| Description |
Gets the participant list resulting from a search. | ||
| Return | osid.offering.ParticipantList | the participant list | |
| Errors | ILLEGAL_STATE | the list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParticipantQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.offering.ParticipantQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParticipantSearchResultsRecord | ||
| Description |
Gets the record corresponding to the given participant
search record | ||
| Parameters | osid.type.Type | participantSearchRecordType | a participant search record type |
| Return | osid.offering.records.ParticipantSearchResultsRecord | the participant search results record | |
| Errors | NULL_ARGUMENT | participantSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(participantSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |