Interface | osid.offering.ParticipantSearchSession | ||
---|---|---|---|
Implements | osid.offering.ParticipantQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Participants may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getParticipantSearch | ||
Description |
Gets a participant search. | ||
Return | osid.offering.ParticipantSearch | the participant search | |
Compliance | mandatory | This method must be implemented. | |
Method | getParticipantSearchOrder | ||
Description |
Gets a participant search order. The | ||
Return | osid.offering.ParticipantSearchOrder | the participant search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getParticipantsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.offering.ParticipantQuery | participantQuery | the participant query |
osid.offering.ParticipantSearch | participantSearch | the participant search | |
Return | osid.offering.ParticipantSearchResults | the search results | |
Errors | NULL_ARGUMENT | participantQuery or participantSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | participantQuery or participantSearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParticipantQueryFromInspector | ||
Description |
Gets the participant query inspector. | ||
Parameters | osid.offering.ParticipantQueryInspector | participantQueryInspector | a participant query inspector |
Return | osid.offering.ParticipantQuery | the participant query | |
Errors | NULL_ARGUMENT | participantQueryInspector is null | |
UNSUPPORTED | participantQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |