Interface DispatchSmartPublisherSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A DispatchQuery can be retrieved from this session and mapped to this Publisher to create a virtual collection of Dispatches . The dispatches may be sequenced using the DispatchSearchOrder from this session.

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

  • 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 associated with this session
      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.

    • getDispatchQuery

      DispatchQuery getDispatchQuery()
      Gets a dispatch query.
      Returns:
      the dispatch query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchSearchOrder

      DispatchSearchOrder getDispatchSearchOrder()
      Gets a dispatch search order.
      Returns:
      the dispatch search order
      Compliance:
      mandatory - This method must be implemented.

    • applyDispatchQuery

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

    • inspectDispatchQuery

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

    • applyDispatchSequencing

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

    • getDispatchQueryFromInspector

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