Interface DispatchProcessorEnablerSmartPublisherSession

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

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

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

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

    • getDispatchProcessorEnablerQuery

      DispatchProcessorEnablerQuery getDispatchProcessorEnablerQuery()
      Gets a dispatch processor enabler query.
      Returns:
      the dispatch processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorEnablerSearchOrder

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

    • applyDispatchProcessorEnablerQuery

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

    • inspectDispatchProcessorEnablerQuery

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

    • applyDispatchProcessorEnablerSequencing

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

    • getDispatchProcessorEnablerQueryFromInspector

      DispatchProcessorEnablerQuery getDispatchProcessorEnablerQueryFromInspector(DispatchProcessorEnablerQueryInspector dispatchProcessorEnablerQueryInspector)
      Gets a dispatch processor enabler query from an inspector.
      Parameters:
      dispatchProcessorEnablerQueryInspector - a dispatch processor enabler query inspector
      Returns:
      the dispatch processor enabler query
      Throws:
      NullArgumentException - dispatchProcessorEnablerQueryInspector is null
      UnsupportedException - dispatchProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.