Interface BrokerEnablerSearchSession

All Superinterfaces:

AutoCloseable, BrokerEnablerQuerySession, Closeable, OsidSession, OsidSession

public interface BrokerEnablerSearchSession
extends BrokerEnablerQuerySession

This session provides methods for searching among BrokerEnablers . The search query is constructed using the BrokerEnablerQuery .

getBrokerEnablersByQuery() is the basic search method and returns a list of BrokerEnablers . A more advanced search may be performed with getBrokerEnablersBySearch() .It accepts a BrokerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBrokerEnablersBySearch() returns a BrokerEnablerSearchResults that can be used to access the resulting BrokerEnablerList or be used to perform a search within the result set through Br okerEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
BrokerEnablerQuery	getBrokerEnablerQueryFromInspector(BrokerEnablerQueryInspector brokerEnablerQueryInspector)	Gets a broker enabler query from an inspector.
BrokerEnablerSearchResults	getBrokerEnablersBySearch(BrokerEnablerQuery brokerEnablerQuery, BrokerEnablerSearch brokerEnablerSearch)	Gets the search results matching the given search query using the given search.
BrokerEnablerSearch	getBrokerEnablerSearch()	Gets a broker enabler search.
BrokerEnablerSearchOrder	getBrokerEnablerSearchOrder()	Gets a broker enabler search order.

Methods inherited from interface BrokerEnablerQuerySession

canSearchBrokerEnablers, getBrokerEnablerQuery, getBrokerEnablersByQuery, getDistributor, getDistributorId, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchBrokerEnablers()	Tests if this user can perform BrokerEnabler searches.
BrokerEnablerQuery	getBrokerEnablerQuery()	Gets a broker enabler query.
BrokerEnablerList	getBrokerEnablersByQuery(BrokerEnablerQuery brokerEnablerQuery)	Gets a list of BrokerEnablers matching the given search.
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

getBrokerEnablerSearch

BrokerEnablerSearch getBrokerEnablerSearch()

Gets a broker enabler search.

Returns:

the broker enabler search

Compliance:

mandatory - This method must be implemented.

getBrokerEnablerSearchOrder

BrokerEnablerSearchOrder getBrokerEnablerSearchOrder()

Gets a broker enabler search order. The BrokerEnablerSearchOrder is supplied to a BrokerEnablerSearch to specify the ordering of results.

Returns:

the broker enabler search order

Compliance:

mandatory - This method must be implemented.

getBrokerEnablersBySearch

BrokerEnablerSearchResults getBrokerEnablersBySearch(BrokerEnablerQuery brokerEnablerQuery,
 BrokerEnablerSearch brokerEnablerSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

brokerEnablerQuery - the broker enabler query

brokerEnablerSearch - the broker enabler search

Returns:

the returned search results

Throws:

NullArgumentException - brokerEnablerQuery or brokerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerEnablerQuery or brokerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerEnablerQueryFromInspector

BrokerEnablerQuery getBrokerEnablerQueryFromInspector(BrokerEnablerQueryInspector brokerEnablerQueryInspector)

Gets a broker enabler query from an inspector. The inspector is available from a BrokerEnablerSearchResults .

Parameters:

brokerEnablerQueryInspector - a broker enabler query inspector

Returns:

the broker enabler query

Throws:

NullArgumentException - brokerEnablerQueryInspector is null

UnsupportedException - brokerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.