Interface DispatchProcessorSmartPublisherSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A DispatchProcessorQuery can be retrieved from this session and mapped to this Publisher to create a virtual collection of DispatchProcessors . The dispatch processors may be sequenced using the DispatchProcessorSearchOrder from this session.

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

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

    • getDispatchProcessorQuery

      DispatchProcessorQuery getDispatchProcessorQuery()
      Gets a dispatch processor query.
      Returns:
      the dispatch processor query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorSearchOrder

      DispatchProcessorSearchOrder getDispatchProcessorSearchOrder()
      Gets a dispatch processor search order.
      Returns:
      the dispatch processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyDispatchProcessorQuery

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

    • inspectDispatchProcessorQuery

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

    • applyDispatchProcessorSequencing

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

    • getDispatchProcessorQueryFromInspector

      DispatchProcessorQuery getDispatchProcessorQueryFromInspector(DispatchProcessorQueryInspector dispatchProcessorQueryInspector)
      Gets a dispatch processor query from an inspector.
      Parameters:
      dispatchProcessorQueryInspector - a dispatch processor query inspector
      Returns:
      the dispatch processor query
      Throws:
      NullArgumentException - dispatchProcessorQueryInspector is null
      UnsupportedException - dispatchProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.