Interface BrokerProcessorSearchSession

All Superinterfaces:
AutoCloseable, BrokerProcessorQuerySession, Closeable, OsidSession, OsidSession
public interface BrokerProcessorSearchSession extends BrokerProcessorQuerySession

This session provides methods for searching among BrokerProcessors . The search query is constructed using the BrokerProcessorQuery .

getBrokerProcessorsByQuery() is the basic search method and returns a list of BrokerProcessors . A more advanced search may be performed with getBrokerProcessorsBySearch() . It accepts a BrokerProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBrokerProcessorsBySearch() returns a BrokerProcessorSearchResults that can be used to access the resulting BrokerProcessorList or be used to perform a search within the result set through Br okerProcessorSearch .

This session defines views that offer differing behaviors for searching.

  • federated distributor view: searches include broker processors in distributors of which this distributor is an ancestor in the distributor hierarchy
  • isolated distributor view: searches are restricted to broker processors in this distributor

Broker processors may have a query record indicated by their respective record types. The query record is accessed via the BrokerProcessorQuery .

  • Method Details

    • getBrokerProcessorSearch

      BrokerProcessorSearch getBrokerProcessorSearch()
      Gets a broker processor search.
      Returns:
      the broker processor search
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorSearchOrder

      BrokerProcessorSearchOrder getBrokerProcessorSearchOrder()
      Gets a broker processor search order. The BrokerProcessorSearchOrder is supplied to a BrokerProcessorSearch to specify the ordering of results.
      Returns:
      the broker processor search order
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorsBySearch

      BrokerProcessorSearchResults getBrokerProcessorsBySearch(BrokerProcessorQuery brokerProcessorQuery, BrokerProcessorSearch brokerProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      brokerProcessorQuery - the broker processor query
      brokerProcessorSearch - the broker processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - brokerProcessorQuery or brokerProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - brokerProcessorQuery or brokerProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorQueryFromInspector

      BrokerProcessorQuery getBrokerProcessorQueryFromInspector(BrokerProcessorQueryInspector brokerProcessorQueryInspector)
      Gets a broker processor query from an inspector. The inspector is available from a BrokerProcessorSearchResults .
      Parameters:
      brokerProcessorQueryInspector - a broker processor query inspector
      Returns:
      the broker processor query
      Throws:
      NullArgumentException - brokerProcessorQueryInspector is null
      UnsupportedException - brokerProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.