Interface ParticipantSmartCatalogueSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ParticipantSmartCatalogueSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ParticipantQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of Participants . The participants may be sequenced using the ParticipantSearchOrder from this session.

This Catalogue has a default query that matches any participant and a default search order that specifies no sequencing. The queries may be examined using a ParticipantQueryInspector . The query may be modified by converting the inspector back to a ParticipantQuery .

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartCatalogues

      boolean canManageSmartCatalogues()
      Tests if this user can manage smart catalogues. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart catalogue management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getParticipantQuery

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

    • getParticipantSearchOrder

      ParticipantSearchOrder getParticipantSearchOrder()
      Gets a participant search order.
      Returns:
      the participant search order
      Compliance:
      mandatory - This method must be implemented.

    • applyParticipantQuery

      void applyParticipantQuery(ParticipantQuery participantQuery) throws OperationFailedException, PermissionDeniedException
      Applies a participant query to this catalogue.
      Parameters:
      participantQuery - the participant query
      Throws:
      NullArgumentException - participantQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - participantQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectParticipantQuery

      ParticipantQueryInspector inspectParticipantQuery() throws OperationFailedException, PermissionDeniedException
      Gets a participant query inspector for this catalogue.
      Returns:
      the participant query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyParticipantSequencing

      void applyParticipantSequencing(ParticipantSearchOrder participantSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a participant search order to this catalogue.
      Parameters:
      participantSearchOrder - the participant search order
      Throws:
      NullArgumentException - participantSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - participantSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getParticipantQueryFromInspector

      ParticipantQuery getParticipantQueryFromInspector(ParticipantQueryInspector participantQueryInspector)
      Gets a participant query from an inspector.
      Parameters:
      participantQueryInspector - a query inspector
      Returns:
      the participant query
      Throws:
      NullArgumentException - participantQueryInspector is null
      UnsupportedException - participantQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.