Interface BrokerConstrainerSearchSession

All Superinterfaces:
AutoCloseable, BrokerConstrainerQuerySession, Closeable, OsidSession, OsidSession
public interface BrokerConstrainerSearchSession extends BrokerConstrainerQuerySession

This session provides methods for searching among BrokerConstrainers . The search query is constructed using the BrokerConstrainerQuery .

getBrokerConstrainersByQuery() is the basic search method and returns a list of BrokerConstrainers . A more advanced search may be performed with getBrokerConstrainersBySearch() . It accepts a BrokerConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBrokerConstrainersBySearch() returns a BrokerConstrainerSearchResults that can be used to access the resulting BrokerConstrainerList or be used to perform a search within the result set through Br okerConstrainerSearch .

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getBrokerConstrainerSearch

      BrokerConstrainerSearch getBrokerConstrainerSearch()
      Gets a broker constrainer search.
      Returns:
      the broker constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerConstrainerSearchOrder

      BrokerConstrainerSearchOrder getBrokerConstrainerSearchOrder()
      Gets a broker constrainer search order. The BrokerConstrainerSearchOrder is supplied to a BrokerConstrainerSearch to specify the ordering of results.
      Returns:
      the broker constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerConstrainersBySearch

      BrokerConstrainerSearchResults getBrokerConstrainersBySearch(BrokerConstrainerQuery brokerConstrainerQuery, BrokerConstrainerSearch brokerConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      brokerConstrainerQuery - the broker constrainer query
      brokerConstrainerSearch - the broker constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - brokerConstrainerQuery or brokerConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - brokerConstrainerQuery or brokerConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerConstrainerQueryFromInspector

      BrokerConstrainerQuery getBrokerConstrainerQueryFromInspector(BrokerConstrainerQueryInspector brokerConstrainerQueryInspector)
      Gets a broker constrainer query from an inspector. The inspector is available from a BrokerConstrainerSearchResults .
      Parameters:
      brokerConstrainerQueryInspector - a broker constrainer query inspector
      Returns:
      the broker constrainer query
      Throws:
      NullArgumentException - brokerConstrainerQueryInspector is null
      UnsupportedException - brokerConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.