OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ParticipantQuerySession
Implementsosid.OsidSession
Description

This session provides methods for querying Participant objects. The search query is constructed using the ParticipantQuery.

This session defines views that offer differing behaviors for searching.

  • federated catalogue view: searches include participants in catalogues of which this catalogue is a ancestor in the catalogue hierarchy
  • isolated catalogue view: searches are restricted to participants in this catalogue

Participants may have a query record indicated by their respective record types. The query record is accessed via the ParticipantQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe catalogue
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchParticipants
Description

Tests if this user can perform Participant searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may wish not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCatalogueView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCatalogueView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this catalogue only.

CompliancemandatoryThis method is must be implemented.
MethodgetParticipantQuery
Description

Gets a participant query.

Returnosid.offering.ParticipantQuerythe participant query
CompliancemandatoryThis method must be implemented.
MethodgetParticipantsByQuery
Description

Gets a list of participants matching the given participant query.

Parametersosid.offering.ParticipantQueryparticipantQuerythe participant query
Returnosid.offering.ParticipantListthe returned ParticipantList
ErrorsNULL_ARGUMENT participantQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED participantQuery is not of this service
CompliancemandatoryThis method must be implemented.