org.osid.provisioning.rules

Interface PoolConstrainerEnablerSearchSession

All Superinterfaces:

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

public interface PoolConstrainerEnablerSearchSession
extends PoolConstrainerEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
PoolConstrainerEnablerQuery	getPoolConstrainerEnablerQueryFromInspector(PoolConstrainerEnablerQueryInspector poolConstrainerEnablerQueryInspector) Gets a pool constrainer enabler query from an inspector.
PoolConstrainerEnablerSearchResults	getPoolConstrainerEnablersBySearch(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery, PoolConstrainerEnablerSearch poolConstrainerEnablerSearch) Gets the search results matching the given search query using the given search.
PoolConstrainerEnablerSearch	getPoolConstrainerEnablerSearch() Gets a pool constrainer enabler search.
PoolConstrainerEnablerSearchOrder	getPoolConstrainerEnablerSearchOrder() Gets a pool constrainer enabler search order.

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

canSearchPoolConstrainerEnablers, getDistributor, getDistributorId, getPoolConstrainerEnablerQuery, getPoolConstrainerEnablersByQuery, 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

getPoolConstrainerEnablerSearch

PoolConstrainerEnablerSearch getPoolConstrainerEnablerSearch()

Gets a pool constrainer enabler search.

Returns:

the pool constrainer enabler search

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablerSearchOrder

PoolConstrainerEnablerSearchOrder getPoolConstrainerEnablerSearchOrder()

Gets a pool constrainer enabler search order. The PoolConstrainerEnablerSearchOrder is supplied to a PoolConstrainerEnablerSearch to specify the ordering of results.

Returns:

the pool constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablersBySearch

PoolConstrainerEnablerSearchResults getPoolConstrainerEnablersBySearch(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery,
                                                                     PoolConstrainerEnablerSearch poolConstrainerEnablerSearch)
                                                                       throws OperationFailedException,
                                                                              PermissionDeniedException

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

Parameters:

poolConstrainerEnablerQuery - the pool constrainer enabler query

poolConstrainerEnablerSearch - the pool constrainer enabler search

Returns:

the returned search results

Throws:

NullArgumentException - poolConstrainerEnablerQuery or poolConstrainerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolConstrainerEnablerQuery or poolConstrainerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablerQueryFromInspector

PoolConstrainerEnablerQuery getPoolConstrainerEnablerQueryFromInspector(PoolConstrainerEnablerQueryInspector poolConstrainerEnablerQueryInspector)

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

Parameters:

poolConstrainerEnablerQueryInspector - a pool constrainer enabler query inspector

Returns:

the pool constrainer enabler query

Throws:

NullArgumentException - poolConstrainerEnablerQueryInspector is null

UnsupportedException - poolConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.