OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.ParticipantSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing participant searches. | ||
| Method | searchAmongParticipants | ||
| Description |
Execute this search among the given list of participants. | ||
| Parameters | osid.id.IdList | participantIds | list of participants |
| Errors | NULL_ARGUMENT | participantIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderParticipantResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.offering.ParticipantSearchOrder | participantSearchOrder | participant search order |
| Errors | NULL_ARGUMENT | participantSearchOrder is null | |
| UNSUPPORTED | participantSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getParticipantSearchRecord | ||
| 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.ParticipantSearchRecord | the participant search 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. | |