Interface DispatchConstrainerEnablerSmartPublisherSession

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

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

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

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

    • getDispatchConstrainerEnablerQuery

      DispatchConstrainerEnablerQuery getDispatchConstrainerEnablerQuery()
      Gets a dispatch constrainer enabler query.
      Returns:
      the dispatch constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainerEnablerSearchOrder

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

    • applyDispatchConstrainerEnablerQuery

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

    • inspectDispatchConstrainerEnablerQuery

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

    • applyDispatchConstrainerEnablerSequencing

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

    • getDispatchConstrainerEnablerQueryFromInspector

      DispatchConstrainerEnablerQuery getDispatchConstrainerEnablerQueryFromInspector(DispatchConstrainerEnablerQueryInspector dispatchConstrainerEnablerQueryInspector)
      Gets a dispatch constrainer enabler query from an inspector.
      Parameters:
      dispatchConstrainerEnablerQueryInspector - a dispatch constrainer enabler query inspector
      Returns:
      the dispatch constrainer enabler query
      Throws:
      NullArgumentException - dispatchConstrainerEnablerQueryInspector is null
      UnsupportedException - dispatchConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.