Interface OfferingQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
OfferingSearchSession
public interface OfferingQuerySession extends OsidSession

This session provides methods for querying Offerings . The search query is constructed using the OfferingQuery .

This session defines views that offer differing behaviors for searching.

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

Offerings may have a query record indicated by their respective record types. The query record is accessed via the OfferingQuery . 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.

    • canSearchOfferings

      boolean canSearchOfferings()
      Tests if this user can perform Offering 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 offerings 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.

    • getOfferingQuery

      OfferingQuery getOfferingQuery()
      Gets an offering query.
      Returns:
      the offering query
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingsByQuery

      OfferingList getOfferingsByQuery(OfferingQuery offeringQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of offerings matching the given offering query.
      Parameters:
      offeringQuery - the offering query
      Returns:
      the returned OfferingList
      Throws:
      NullArgumentException - offeringQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - offeringQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.