Interface | osid.offering.ParticipantQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for querying 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 | getCatalogueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalogue Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Return | osid.offering.Catalogue | the catalogue | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchParticipants | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCatalogueView | ||
Description |
Federates the view for methods in this session. A federated view will include participants in catalogues which are children of this catalogue in the catalogue hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogueView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this catalogue only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getParticipantQuery | ||
Description |
Gets a participant query. | ||
Return | osid.offering.ParticipantQuery | the participant query | |
Compliance | mandatory | This method must be implemented. | |
Method | getParticipantsByQuery | ||
Description |
Gets a list of participants matching the given participant query. | ||
Parameters | osid.offering.ParticipantQuery | participantQuery | the participant query |
Return | osid.offering.ParticipantList | the returned ParticipantList | |
Errors | NULL_ARGUMENT | participantQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | participantQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |