Interface DispatchQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
DispatchSearchSession
public interface DispatchQuerySession extends OsidSession

This session provides methods for searching Dispatches . The search query is constructed using the DispatchQuery . The dispatch record Type also specifies the record for the dispatch query.

Dispatches may have a query record indicated by their respective record types. The query record is accessed via the DispatchQuery . The returns in this session may not be cast directly to these interfaces.

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

    • canSearchDispatches

      boolean canSearchDispatches()
      Tests if this user can perform Dispatch 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 opt not to offer search 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 dispatches 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 retrievals to this publisher only.
      Compliance:
      mandatory - This method is must be implemented.

    • getDispatchQuery

      DispatchQuery getDispatchQuery()
      Gets a dispatch query.
      Returns:
      the dispatch query
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchesByQuery

      DispatchList getDispatchesByQuery(DispatchQuery dispatchQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Dispatches matching the given dispatch query.
      Parameters:
      dispatchQuery - the dispatch query
      Returns:
      the returned DispatchList
      Throws:
      NullArgumentException - dispatchQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - dispatchQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.