Interface OfferingSmartCatalogueSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An OfferingQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of Offerings . The offerings may be sequenced using the OfferingSearchOrder from this session.

This Catalogue has a default query that matches any offering and a default search order that specifies no sequencing. The queries may be examined using an OfferingQueryInspector . The query may be modified by converting the inspector back to a n OfferingQuery .

  • 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.

    • getOfferingQuery

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

    • getOfferingSearchOrder

      OfferingSearchOrder getOfferingSearchOrder()
      Gets an offering search order.
      Returns:
      the offering search order
      Compliance:
      mandatory - This method must be implemented.

    • applyOfferingQuery

      void applyOfferingQuery(OfferingQuery offeringQuery) throws OperationFailedException, PermissionDeniedException
      Applies an offering query to this catalogue.
      Parameters:
      offeringQuery - the offering query
      Throws:
      NullArgumentException - offeringQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - offeringQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectOfferingQuery

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

    • applyOfferingSequencing

      void applyOfferingSequencing(OfferingSearchOrder offeringSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an offering search order to this catalogue.
      Parameters:
      offeringSearchOrder - the offering search order
      Throws:
      NullArgumentException - offeringSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - offeringSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingQueryFromInspector

      OfferingQuery getOfferingQueryFromInspector(OfferingQueryInspector offeringQueryInspector)
      Gets an offering query from an inspector.
      Parameters:
      offeringQueryInspector - a query inspector
      Returns:
      the offering query
      Throws:
      NullArgumentException - offeringQueryInspector is null
      UnsupportedException - offeringQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.