org.osid.provisioning.rules

Interface PoolProcessorSearchSession

All Superinterfaces:

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

public interface PoolProcessorSearchSession
extends PoolProcessorQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
PoolProcessorQuery	getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector) Gets a pool processor query from an inspector.
PoolProcessorSearchResults	getPoolProcessorsBySearch(PoolProcessorQuery poolProcessorQuery, PoolProcessorSearch poolProcessorSearch) Gets the search results matching the given search query using the given search.
PoolProcessorSearch	getPoolProcessorSearch() Gets a pool processor search.
PoolProcessorSearchOrder	getPoolProcessorSearchOrder() Gets a pool processor search order.

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

canSearchPoolProcessors, getDistributor, getDistributorId, getPoolProcessorQuery, getPoolProcessorsByQuery, 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

getPoolProcessorSearch

PoolProcessorSearch getPoolProcessorSearch()

Gets a pool processor search.

Returns:

the pool processor search

Compliance:

mandatory - This method must be implemented.

getPoolProcessorSearchOrder

PoolProcessorSearchOrder getPoolProcessorSearchOrder()

Gets a pool processor search order. The PoolProcessorSearchOrder is supplied to a PoolProcessorSearch to specify the ordering of results.

Returns:

the pool processor search order

Compliance:

mandatory - This method must be implemented.

getPoolProcessorsBySearch

PoolProcessorSearchResults getPoolProcessorsBySearch(PoolProcessorQuery poolProcessorQuery,
                                                   PoolProcessorSearch poolProcessorSearch)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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

Parameters:

poolProcessorQuery - the pool processor query

poolProcessorSearch - the pool processor search

Returns:

the returned search results

Throws:

NullArgumentException - poolProcessorQuery or poolProcessorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolProcessorQuery or poolProcessorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolProcessorQueryFromInspector

PoolProcessorQuery getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector)

Gets a pool processor query from an inspector. The inspector is available from a PoolProcessorSearchResults.

Parameters:

poolProcessorQueryInspector - a pool processor query inspector

Returns:

the pool processor query

Throws:

NullArgumentException - poolProcessorQueryInspector is null

UnsupportedException - poolProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.