Interface ProvisionSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface ProvisionQuerySession

canSearchProvisions, getDistributor, getDistributorId, getProvisionQuery, getProvisionsByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchProvisions()	Tests if this user can perform Provision lookups.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
ProvisionQuery	getProvisionQuery()	Gets a provision query.
ProvisionList	getProvisionsByQuery(ProvisionQuery provisionQuery)	Gets a list of Provisions matching the given provision query,
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Method Details

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.