org.osid.provisioning

Interface PoolSearchSession

All Superinterfaces:

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

public interface PoolSearchSession
extends PoolQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
PoolQuery	getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector) Gets a pool query from an inspector.
PoolSearchResults	getPoolsBySearch(PoolQuery poolQuery, PoolSearch poolSearch) Gets the search results matching the given search query using the given search.
PoolSearch	getPoolSearch() Gets a pool search.
PoolSearchOrder	getPoolSearchOrder() Gets a pool search order.

Methods inherited from interface org.osid.provisioning.PoolQuerySession

canSearchPools, getDistributor, getDistributorId, getPoolQuery, getPoolsByQuery, 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

getPoolSearch

PoolSearch getPoolSearch()

Gets a pool search.

Returns:

the pool search

Compliance:

mandatory - This method must be implemented.

getPoolSearchOrder

PoolSearchOrder getPoolSearchOrder()

Gets a pool search order. The PoolSearchOrder is supplied to a PoolSearch to specify the ordering of results.

Returns:

the pool search order

Compliance:

mandatory - This method must be implemented.

getPoolsBySearch

PoolSearchResults getPoolsBySearch(PoolQuery poolQuery,
                                 PoolSearch poolSearch)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

poolQuery - the pool query

poolSearch - the pool search

Returns:

the pool search results

Throws:

NullArgumentException - poolQuery or poolSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolQuery or poolSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolQueryFromInspector

PoolQuery getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector)

Gets a pool query from an inspector. The inspector is available from a PoolSearchResults.

Parameters:

poolQueryInspector - a pool query inspector

Returns:

the pool query

Throws:

NullArgumentException - poolQueryInspector is null

UnsupportedException - poolQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.