Interface OfferingConstrainerSmartCatalogueSession

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

This session manages queries and sequencing to create "smart" dynamic catalogues. An OfferingConstrainerQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of offering constrainers. The offering constrainer may be sequenced using the OfferingConstrainerSearchOrder from this session.

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

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

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

    • getOfferingConstrainerQuery

      OfferingConstrainerQuery getOfferingConstrainerQuery()
      Gets an offering constrainer query.
      Returns:
      the offering constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerSearchOrder

      OfferingConstrainerSearchOrder getOfferingConstrainerSearchOrder()
      Gets an offering constrainer search order.
      Returns:
      the offering constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyOfferingConstrainerQuery

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

    • inspectOfferingConstrainerQuery

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

    • applyOfferingConstrainerSequencing

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

    • getOfferingConstrainerQueryFromInspector

      OfferingConstrainerQuery getOfferingConstrainerQueryFromInspector(OfferingConstrainerQueryInspector offeringConstrainerQueryInspector)
      Gets an offering constrainer query from an inspector.
      Parameters:
      offeringConstrainerQueryInspector - an offering constrainer query inspector
      Returns:
      the offering constrainer query
      Throws:
      NullArgumentException - offeringConstrainerQueryInspector is null
      UnsupportedException - offeringConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.