Interface BrokerConstrainerEnablerSearchSession

All Superinterfaces:
AutoCloseable, BrokerConstrainerEnablerQuerySession, Closeable, OsidSession, OsidSession
public interface BrokerConstrainerEnablerSearchSession extends BrokerConstrainerEnablerQuerySession

This session provides methods for searching among BrokerConstrainerEnablers . The search query is constructed using the BrokerConstrainerEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

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

Broker constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the BrokerConstrainerEnablerQuery .

  • Method Details

    • getBrokerConstrainerEnablerSearch

      BrokerConstrainerEnablerSearch getBrokerConstrainerEnablerSearch()
      Gets a broker constrainer enabler search.
      Returns:
      the broker constrainer enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerConstrainerEnablerSearchOrder

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

    • getBrokerConstrainerEnablersBySearch

      BrokerConstrainerEnablerSearchResults getBrokerConstrainerEnablersBySearch(BrokerEnablerQuery brokerConstrainerEnablerQuery, BrokerConstrainerEnablerSearch brokerConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      brokerConstrainerEnablerQuery - the broker constrainer enabler query
      brokerConstrainerEnablerSearch - the broker constrainer enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - brokerConstrainerEnablerQuery or brokerConstrainerEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - brokerConstrainerEnablerQuery or brokerConstrainerEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerConstrainerEnablerQueryFromInspector

      BrokerConstrainerEnablerQuery getBrokerConstrainerEnablerQueryFromInspector(BrokerConstrainerEnablerQueryInspector brokerConstrainerEnablerQueryInspector)
      Gets a broker constrainer enabler query from an inspector. The inspector is available from a BrokerConstrainerEnablerSearchResults .
      Parameters:
      brokerConstrainerEnablerQueryInspector - a broker constrainer enabler query inspector
      Returns:
      the broker constrainer enabler query
      Throws:
      NullArgumentException - brokerConstrainerEnablerQueryInspector is null
      UnsupportedException - brokerConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.