org.osid.provisioning

Interface BrokerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, BrokerQuerySession, java.io.Closeable, OsidSession

public interface BrokerSearchSession
extends BrokerQuerySession

This session provides methods for searching among Broker objects. The search query is constructed using the BrokerQuery.

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

This session defines views that offer differing behaviors for searching.

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

Brokers may have a query record indicated by their respective record types. The query record is accessed via the BrokerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerQuery	getBrokerQueryFromInspector(BrokerQueryInspector brokerQueryInspector) Gets a broker query from an inspector.
BrokerSearchResults	getBrokersBySearch(BrokerQuery brokerQuery, BrokerSearch brokerSearch) Gets the search results matching the given search query using the given search.
BrokerSearch	getBrokerSearch() Gets a broker search.
BrokerSearchOrder	getBrokerSearchOrder() Gets a broker search order.

Methods inherited from interface org.osid.provisioning.BrokerQuerySession

canSearchBrokers, getBrokerQuery, getBrokersByQuery, getDistributor, getDistributorId, useFederatedDistributorView, useIsolatedDistributorView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBrokerSearch

BrokerSearch getBrokerSearch()

Gets a broker search.

Returns:

the broker search

Compliance:

mandatory - This method must be implemented.

getBrokerSearchOrder

BrokerSearchOrder getBrokerSearchOrder()

Gets a broker search order. The BrokerSearchOrder is supplied to a BrokerSearch to specify the ordering of results.

Returns:

the broker search order

Compliance:

mandatory - This method must be implemented.

getBrokersBySearch

BrokerSearchResults getBrokersBySearch(BrokerQuery brokerQuery,
                                     BrokerSearch brokerSearch)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

brokerQuery - the broker query

brokerSearch - the broker search

Returns:

the returned search results

Throws:

NullArgumentException - brokerQuery or brokerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerQuery or brokerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerQueryFromInspector

BrokerQuery getBrokerQueryFromInspector(BrokerQueryInspector brokerQueryInspector)

Gets a broker query from an inspector. The inspector is available from a BrokerSearchResults.

Parameters:

brokerQueryInspector - a broker query inspector

Returns:

the broker query

Throws:

NullArgumentException - brokerQueryInspector is null

UnsupportedException - brokerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.