Interface OfferingConstrainerEnablerSmartCatalogueSession

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

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

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

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

    • getOfferingConstrainerEnablerQuery

      OfferingConstrainerEnablerQuery getOfferingConstrainerEnablerQuery()
      Gets an offering constrainer enabler query.
      Returns:
      the offering constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerEnablerSearchOrder

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

    • applyOfferingConstrainerEnablerQuery

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

    • inspectOfferingConstrainerEnablerQuery

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

    • applyOfferingConstrainerEnablerSequencing

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

    • getOfferingConstrainerEnablerQueryFromInspector

      OfferingConstrainerEnablerQuery getOfferingConstrainerEnablerQueryFromInspector(OfferingConstrainerEnablerQueryInspector offeringConstrainerEnablerQueryInspector)
      Gets an offering constrainer enabler query from an inspector.
      Parameters:
      offeringConstrainerEnablerQueryInspector - an offering constrainer enabler query inspector
      Returns:
      the offering constrainer enabler query
      Throws:
      NullArgumentException - offeringConstrainerEnablerQueryInspector is null
      UnsupportedException - offeringConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.