Interface DispatchEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
DispatchEnablerSearchSession
public interface DispatchEnablerQuerySession extends OsidSession

This session provides methods for searching among DispatchEnabler objects. The search query is constructed using the DispatchEnablerQuery .

This session defines views that offer differing behaviors for searching.

  • federated publisher view: searches include dispatch enablers in publishers of which this publisher is an ancestor in the publisher hierarchy
  • isolated publisher view: searches are restricted to dispatch enablers in this publisher

Dispatch enablers may have a query record indicated by their respective record types. The query record is accessed via the 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchDispatchEnablers

      boolean canSearchDispatchEnablers()
      Tests if this user can perform DispatchEnabler searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedPublisherView

      void useFederatedPublisherView()
      Federates the view for methods in this session. A federated view will include dispatch enablers in publishers which are children of this publisher in the publisher hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPublisherView

      void useIsolatedPublisherView()
      Isolates the view for methods in this session. An isolated view restricts searches to this publisher only.
      Compliance:
      mandatory - This method is must be implemented.

    • getDispatchEnablerQuery

      DispatchEnablerQuery getDispatchEnablerQuery()
      Gets a dispatch enabler query.
      Returns:
      the dispatch enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablersByQuery

      DispatchEnablerList getDispatchEnablersByQuery(DispatchEnablerQuery dispatchEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of DispatchEnablers matching the given search.
      Parameters:
      dispatchEnablerQuery - the dispatch enabler query
      Returns:
      the returned DispatchEnablerList
      Throws:
      NullArgumentException - dispatchEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - dispatchEnablerQuery did not originate from getDispatchEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.