Interface DispatchConstrainerSmartPublisherSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A DispatchConstrainerQuery can be retrieved from this session and mapped to this Publisher to create a virtual collection of DispatchConstrainers . The dispatch constrainers may be sequenced using the DispatchConstrainerSearchOrder from this session.

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

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

    • getDispatchConstrainerQuery

      DispatchConstrainerQuery getDispatchConstrainerQuery()
      Gets a dispatch constrainer query.
      Returns:
      the dispatch constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainerSearchOrder

      DispatchConstrainerSearchOrder getDispatchConstrainerSearchOrder()
      Gets a dispatch constrainer search order.
      Returns:
      the dispatch constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyDispatchConstrainerQuery

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

    • inspectDispatchConstrainerQuery

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

    • applyDispatchConstrainerSequencing

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

    • getDispatchConstrainerQueryFromInspector

      DispatchConstrainerQuery getDispatchConstrainerQueryFromInspector(DispatchConstrainerQueryInspector dispatchConstrainerQueryInspector)
      Gets a dispatch constrainer query from an inspector.
      Parameters:
      dispatchConstrainerQueryInspector - a dispatch constrainer query inspector
      Returns:
      the dispatch constrainer query
      Throws:
      NullArgumentException - dispatchConstrainerQueryInspector is null
      UnsupportedException - dispatchConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.