Interface DispatchEnablerSmartPublisherSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A DispatchEnablerQuery can be retrieved from this session and mapped to this Publisher to create a virtual collection of DispatchEnablers . The dispatch enablers may be sequenced using the DispatchEnablerSearchOrder from this session.

This Publisher has a default query that matches any dispatch enabler and a default search order that specifies no sequencing. The queries may be examined using a DispatchEnablerQueryInspector . The query may be modified by converting the inspector back to a DispatchEnablerQuery .

  • Method Details

    • getPublisherId

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

    • getPublisher

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

    • canManageSmartPublishers

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

    • getDispatchEnablerQuery

      DispatchEnablerQuery getDispatchEnablerQuery()
      Gets a dispatch enabler query.
      Returns:
      the dispatch enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablerSearchOrder

      DispatchEnablerSearchOrder getDispatchEnablerSearchOrder()
      Gets a dispatch enabler search order.
      Returns:
      the dispatch enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyDispatchEnablerQuery

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

    • inspectDispatchEnablerQuery

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

    • applyDispatchEnablerSequencing

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

    • getDispatchEnablerQueryFromInspector

      DispatchQuery getDispatchEnablerQueryFromInspector(DispatchEnablerQueryInspector dispatchEnablerQueryInspector)
      Gets a dispatch enabler query from an inspector.
      Parameters:
      dispatchEnablerQueryInspector - a dispatch enabler query inspector
      Returns:
      the dispatch enabler query
      Throws:
      NullArgumentException - dispatchEnablerQueryInspector is null
      UnsupportedException - dispatchEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.