org.osid.provisioning

Interface ProvisionSearchSession

All Superinterfaces:

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

public interface ProvisionSearchSession
extends ProvisionQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
ProvisionQuery	getProvisionQueryFromInspector(ProvisionQueryInspector provisionQueryInspector) Gets a provision query from an inspector.
ProvisionSearchResults	getProvisionsBySearch(ProvisionQuery provisionQuery, ProvisionSearch provisionSearch) Gets the search results matching the given search query using the given search.
ProvisionSearch	getProvisionSearch() Gets a provision search.
ProvisionSearchOrder	getProvisionSearchOrder() Gets a provision search order.

Methods inherited from interface org.osid.provisioning.ProvisionQuerySession

canSearchProvisions, getDistributor, getDistributorId, getProvisionQuery, getProvisionsByQuery, 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

getProvisionSearch

ProvisionSearch getProvisionSearch()

Gets a provision search.

Returns:

the provision search

Compliance:

mandatory - This method must be implemented.

getProvisionSearchOrder

ProvisionSearchOrder getProvisionSearchOrder()

Gets a provision search order. The ProvisionSearchOrder is supplied to a ProvisionSearch to specify the ordering of results.

Returns:

the provision search order

Compliance:

mandatory - This method must be implemented.

getProvisionsBySearch

ProvisionSearchResults getProvisionsBySearch(ProvisionQuery provisionQuery,
                                           ProvisionSearch provisionSearch)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

provisionQuery - the provision query

provisionSearch - the provision search

Returns:

the provision search results

Throws:

NullArgumentException - provisionQuery or provisionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - provisionQuery or provisionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProvisionQueryFromInspector

ProvisionQuery getProvisionQueryFromInspector(ProvisionQueryInspector provisionQueryInspector)

Gets a provision query from an inspector. The inspector is available from a ProvisionSearchResults.

Parameters:

provisionQueryInspector - a provision query inspector

Returns:

the provision query

Throws:

NullArgumentException - provisionQueryInspector is null

UnsupportedException - provisionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.