Interface CanonicalUnitSmartCatalogueSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CanonicalUnitQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of CanonicalUnits . The canonical units may be sequenced using the CanonicalUnitSearchOrder from this session.

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

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

    • getCanonicalUnitQuery

      CanonicalUnitQuery getCanonicalUnitQuery()
      Gets a canonical unit query.
      Returns:
      the canonical unit query
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitSearchOrder

      CanonicalUnitSearchOrder getCanonicalUnitSearchOrder()
      Gets a canonical unit search order.
      Returns:
      the canonical unit search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCanonicalUnitQuery

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

    • inspectCanonicalUnitQuery

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

    • applyCanonicalUnitSequencing

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

    • getCanonicalUnitQueryFromInspector

      CanonicalUnitQuery getCanonicalUnitQueryFromInspector(CanonicalUnitQueryInspector canonicalUnitQueryInspector)
      Gets a canonical unit query from an inspector.
      Parameters:
      canonicalUnitQueryInspector - a query inspector
      Returns:
      the canonical unit query
      Throws:
      NullArgumentException - canonicalUnitQueryInspector is null
      UnsupportedException - canonicalUnitQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.