Interface DispatchConstrainerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, DispatchConstrainerQuerySession, OsidSession, OsidSession
public interface DispatchConstrainerSearchSession extends DispatchConstrainerQuerySession

This session provides methods for searching among DispatchConstrainers . The search query is constructed using the DispatchConstrainerQuery .

getDispatchConstrainersByQuery() is the basic search method and returns a list of DispatchConstrainers . A more advanced search may be performed with getDispatchConstrainersBySearch() . It accepts a DispatchConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDispatchConstrainersBySearch() returns a DispatchConstrainerSearchResults that can be used to access the resulting DispatchConstrainerList or be used to perform a search within the result set through DispatchConstrainerSearch .

This session defines views that offer differing behaviors for searching.

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

Dispatch constrainers may have a query record indicated by their respective record types. The query record is accessed via the DispatchConstrainerQuery .

  • Method Details

    • getDispatchConstrainerSearch

      DispatchConstrainerSearch getDispatchConstrainerSearch()
      Gets a dispatch constrainer search.
      Returns:
      the dispatch constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainerSearchOrder

      DispatchConstrainerSearchOrder getDispatchConstrainerSearchOrder()
      Gets a dispatch constrainer search order. The DispatchConstrainerSearchOrder is supplied to a DispatchConstrainerSearch to specify the ordering of results.
      Returns:
      the dispatch constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainersBySearch

      DispatchConstrainerSearchResults getDispatchConstrainersBySearch(DispatchConstrainerQuery dispatchConstrainerQuery, DispatchConstrainerSearch dispatchConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      dispatchConstrainerQuery - the dispatch constrainer query
      dispatchConstrainerSearch - the dispatch constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - dispatchConstrainerQuery or dispatchConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - dispatchConstrainerQuery or dispatchConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainerQueryFromInspector

      DispatchConstrainerQuery getDispatchConstrainerQueryFromInspector(DispatchConstrainerQueryInspector dispatchConstrainerQueryInspector)
      Gets a dispatch constrainer query from an inspector. The inspector is available from a DispatchConstrainerSearchResults .
      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.