Interface ParticipantQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ParticipantSearchSession
public interface ParticipantQuerySession extends OsidSession

This session provides methods for querying Participants. 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 an 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.

  • Method Details

    • getCatalogueId

      Id getCatalogueId()
      Gets the Catalogue Id associated with this session.
      Returns:
      the Catalogue Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogue

      Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
      Gets the Catalogue associated with this session.
      Returns:
      the catalogue
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchParticipants

      boolean canSearchParticipants()
      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.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCatalogueView

      void useFederatedCatalogueView()
      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.

    • useIsolatedCatalogueView

      void useIsolatedCatalogueView()
      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.

    • getParticipantQuery

      ParticipantQuery getParticipantQuery()
      Gets a participant query.
      Returns:
      the participant query
      Compliance:
      mandatory - This method must be implemented.

    • getParticipantsByQuery

      ParticipantList getParticipantsByQuery(ParticipantQuery participantQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of participants matching the given participant query.
      Parameters:
      participantQuery - the participant query
      Returns:
      the returned ParticipantList
      Throws:
      NullArgumentException - participantQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - participantQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.