Interface CanonicalUnitProcessorEnablerSmartCatalogueSession

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

This session manages queries and sequencing to create "smart" dynamic catalogues. A CanonicalUnitProcessorEnablerQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of canonical unit processor enablers. The canonical unit processor enablers may be sequenced using the CanonicalUnitProcessorEnablerSearchOrder from this session.

This Catalogue has a default query that matches any canonical unit processor enabler and a default search order that specifies no sequencing. The queries may be examined using a CanonicalUnitProcessorEnablerQueryInspector . The query may be modified by converting the inspector back to a CanonicalUnitProcessorEnablerQuery .

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

    • getCanonicalUnitProcessorEnablerQuery

      CanonicalUnitProcessorEnablerQuery getCanonicalUnitProcessorEnablerQuery()
      Gets a canonical unit processor enabler query.
      Returns:
      the canonical unit processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablerSearchOrder

      CanonicalUnitProcessorEnablerSearchOrder getCanonicalUnitProcessorEnablerSearchOrder()
      Gets a canonical unit processor enabler search order.
      Returns:
      the canonical unit processor enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCanonicalUnitProcessorEnablerQuery

      void applyCanonicalUnitProcessorEnablerQuery(CanonicalUnitProcessorEnablerQuery canonicalUnitProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a canonical unit processor enabler query to this catalogue.
      Parameters:
      canonicalUnitProcessorEnablerQuery - the canonical unit processor enabler query
      Throws:
      NullArgumentException - canonicalUnitProcessorEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - canonicalUnitProcessorEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectCanonicalUnitProcessorEnablerQuery

      CanonicalUnitProcessorEnablerQueryInspector inspectCanonicalUnitProcessorEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a canonical unit processor enabler query inspector for this catalogue.
      Returns:
      the canonical unit processor enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyCanonicalUnitProcessorEnablerSequencing

      void applyCanonicalUnitProcessorEnablerSequencing(CanonicalUnitProcessorEnablerSearchOrder canonicalUnitProcessorEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a canonical unit processor enabler search order to this catalogue.
      Parameters:
      canonicalUnitProcessorEnablerSearchOrder - the canonical unit processor enabler search order
      Throws:
      NullArgumentException - canonicalUnitProcessorEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - canonicalUnitProcessorEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablerQueryFromInspector

      CanonicalUnitProcessorEnablerQuery getCanonicalUnitProcessorEnablerQueryFromInspector(CanonicalUnitProcessorEnablerQueryInspector canonicalUnitProcessorEnablerQueryInspector)
      Gets a canonical unit processor enabler query from an inspector.
      Parameters:
      canonicalUnitProcessorEnablerQueryInspector - a canonical unit processor enabler query inspector
      Returns:
      the canonical unit processor enabler query
      Throws:
      NullArgumentException - canonicalUnitProcessorEnablerQueryInspector is null
      UnsupportedException - canonicalUnitProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.