Interface CatalogEnablerSmartCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CatalogEnablerQuery can be retrieved from this session and mapped to this Catalog to create a virtual collection of catalog enablers. The catalog enablers may be sequenced using the CatalogEnablerSearchOrder from this session.

This Catalog has a default query that matches any catalog enabler and a default search order that specifies no sequencing. The queries may be examined using a CatalogEnablerQueryInspector . The query may be modified by converting the inspector back to a CatalogEnablerQuery .

  • Method Details

    • getCatalogId

      Id getCatalogId()
      Gets the Catalog Id associated with this session.
      Returns:
      the Catalog Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCatalog

      Catalog getCatalog() throws OperationFailedException, PermissionDeniedException
      Gets the Catalog associated with this session.
      Returns:
      the catalog
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartCatalogs

      boolean canManageSmartCatalogs()
      Tests if this user can manage smart catalogs. 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 catalog management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogEnablerQuery

      CatalogEnablerQuery getCatalogEnablerQuery()
      Gets a catalog enabler query.
      Returns:
      the catalog enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogEnablerSearchOrder

      CatalogEnablerSearchOrder getCatalogEnablerSearchOrder()
      Gets a catalog enabler search order.
      Returns:
      the catalog enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCatalogEnablerQuery

      void applyCatalogEnablerQuery(CatalogEnablerQuery catalogEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a catalog enabler query to this catalog.
      Parameters:
      catalogEnablerQuery - the catalog enabler query
      Throws:
      NullArgumentException - catalogEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - catalogEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectCatalogEnablerQuery

      CatalogEnablerQueryInspector inspectCatalogEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a catalog enabler query inspector for this catalog.
      Returns:
      the catalog enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyCatalogEnablerSequencing

      void applyCatalogEnablerSequencing(CatalogEnablerSearchOrder catalogEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a catalog enabler search order to this catalog.
      Parameters:
      catalogEnablerSearchOrder - the catalog enabler search order
      Throws:
      NullArgumentException - catalogEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - catalogEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogEnablerQueryFromInspector

      CatalogEnablerQuery getCatalogEnablerQueryFromInspector(CatalogEnablerQueryInspector catalogEnablerQueryInspector)
      Gets a catalog enabler query from an inspector.
      Parameters:
      catalogEnablerQueryInspector - a catalog enabler query inspector
      Returns:
      the catalog enabler query
      Throws:
      NullArgumentException - catalogEnablerQueryInspector is null
      UnsupportedException - catalogEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.