org.osid.provisioning.rules

Interface PoolConstrainerSearchSession

All Superinterfaces:

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

public interface PoolConstrainerSearchSession
extends PoolConstrainerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
PoolConstrainerQuery	getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector) Gets a pool constrainer query from an inspector.
PoolConstrainerSearchResults	getPoolConstrainersBySearch(PoolConstrainerQuery poolConstrainerQuery, PoolConstrainerSearch poolConstrainerSearch) Gets the search results matching the given search query using the given search.
PoolConstrainerSearch	getPoolConstrainerSearch() Gets a pool constrainer search.
PoolConstrainerSearchOrder	getPoolConstrainerSearchOrder() Gets a pool constrainer search order.

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

canSearchPoolConstrainers, getDistributor, getDistributorId, getPoolConstrainerQuery, getPoolConstrainersByQuery, 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

getPoolConstrainerSearch

PoolConstrainerSearch getPoolConstrainerSearch()

Gets a pool constrainer search.

Returns:

the pool constrainer search

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerSearchOrder

PoolConstrainerSearchOrder getPoolConstrainerSearchOrder()

Gets a pool constrainer search order. The PoolConstrainerSearchOrder is supplied to a PoolConstrainerSearch to specify the ordering of results.

Returns:

the pool constrainer search order

Compliance:

mandatory - This method must be implemented.

getPoolConstrainersBySearch

PoolConstrainerSearchResults getPoolConstrainersBySearch(PoolConstrainerQuery poolConstrainerQuery,
                                                       PoolConstrainerSearch poolConstrainerSearch)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

poolConstrainerQuery - the pool constrainer query

poolConstrainerSearch - the pool constrainer search

Returns:

the returned search results

Throws:

NullArgumentException - poolConstrainerQuery or poolConstrainerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolConstrainerQuery or poolConstrainerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerQueryFromInspector

PoolConstrainerQuery getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector)

Gets a pool constrainer query from an inspector. The inspector is available from a PoolConstrainerSearchResults.

Parameters:

poolConstrainerQueryInspector - a pool constrainer query inspector

Returns:

the pool constrainer query

Throws:

NullArgumentException - poolConstrainerQueryInspector is null

UnsupportedException - poolConstrainerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.