org.osid.provisioning.rules

Interface BrokerProcessorEnablerSearchSession

All Superinterfaces:

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

public interface BrokerProcessorEnablerSearchSession
extends BrokerProcessorEnablerQuerySession

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

getBrokerProcessorEnablersByQuery() is the basic search method and returns a list of BrokerProcessorEnablers. A more advanced search may be performed with getBrokerProcessorEnablersBySearch(). It accepts a BrokerProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as provisioning. getBrokerProcessorEnablersBySearch() returns a BrokerProcessorEnablerSearchResults that can be used to access the resulting BrokerProcessorEnablerList or be used to perform a search within the result set through BrokerProcessorEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
BrokerProcessorEnablerQuery	getBrokerProcessorEnablerQueryFromInspector(BrokerProcessorEnablerQueryInspector brokerProcessorEnablerQueryInspector) Gets a broker processor enabler query from an inspector.
BrokerProcessorEnablerSearchResults	getBrokerProcessorEnablersBySearch(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery, BrokerProcessorEnablerSearch brokerProcessorEnablerSearch) Gets the search results matching the given search query using the given search.
BrokerProcessorEnablerSearch	getBrokerProcessorEnablerSearch() Gets a broker processor enabler search.
BrokerProcessorEnablerSearchOrder	getBrokerProcessorEnablerSearchOrder() Gets a broker processor enabler search order.

Methods inherited from interface org.osid.provisioning.rules.BrokerProcessorEnablerQuerySession

canSearchBrokerProcessorEnablers, getBrokerProcessorEnablerQuery, getBrokerProcessorEnablersByQuery, 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

getBrokerProcessorEnablerSearch

BrokerProcessorEnablerSearch getBrokerProcessorEnablerSearch()

Gets a broker processor enabler search.

Returns:

the broker processor enabler search

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorEnablerSearchOrder

BrokerProcessorEnablerSearchOrder getBrokerProcessorEnablerSearchOrder()

Gets a broker processor enabler search order. The BrokerProcessorEnablerSearchOrder is supplied to a BrokerProcessorEnablerSearch to specify the ordering of results.

Returns:

the broker processor enabler search order

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorEnablersBySearch

BrokerProcessorEnablerSearchResults getBrokerProcessorEnablersBySearch(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery,
                                                                     BrokerProcessorEnablerSearch brokerProcessorEnablerSearch)
                                                                       throws OperationFailedException,
                                                                              PermissionDeniedException

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

Parameters:

brokerProcessorEnablerQuery - the broker processor enabler query

brokerProcessorEnablerSearch - the broker processor enabler search

Returns:

the returned search results

Throws:

NullArgumentException - brokerProcessorEnablerQuery or brokerProcessorEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerProcessorEnablerQuery or brokerProcessorEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorEnablerQueryFromInspector

BrokerProcessorEnablerQuery getBrokerProcessorEnablerQueryFromInspector(BrokerProcessorEnablerQueryInspector brokerProcessorEnablerQueryInspector)

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

Parameters:

brokerProcessorEnablerQueryInspector - a broker processor enabler query inspector

Returns:

the broker processor enabler query

Throws:

NullArgumentException - brokerProcessorEnablerQueryInspector is null

UnsupportedException - brokerProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.