Interface BrokerSearchSession

All Superinterfaces:

AutoCloseable, BrokerQuerySession, Closeable, OsidSession, 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

Modifier and Type	Method	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 BrokerQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchBrokers()	Tests if this user can perform Broker lookups.
BrokerQuery	getBrokerQuery()	Gets a broker query.
BrokerList	getBrokersByQuery(BrokerQuery brokerQuery)	Gets a list of Brokers matching the given broker query.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.