Interface ProvisionableSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProvisionableQuerySession

public interface ProvisionableSearchSession
extends ProvisionableQuerySession

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

getProvisionablesByQuery() is the basic search method and returns a list of Provisionables . A more advanced search may be performed with getProvisionablesBySearch() .It accepts an ProvisionableSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProvisionablesBySearch() returns an ProvisionableSearchResults that can be used to access the resulting ProvisionableList or be used to perform a search within the result set through ProvisionableSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
ProvisionableQuery	getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector)	Gets a provisionable query from an inspector.
ProvisionableSearchResults	getProvisionablesBySearch(ProvisionableQuery provisionableQuery, ProvisionableSearch provisionableSearch)	Gets the search results matching the given search query using the given search.
ProvisionableSearch	getProvisionableSearch()	Gets a provisionable search.
ProvisionableSearchOrder	getProvisionableSearchOrder()	Gets a provisionable 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 ProvisionableQuerySession

canSearchProvisionables, getDistributor, getDistributorId, getProvisionableQuery, getProvisionablesByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchProvisionables()	Tests if this user can perform Provisionable lookups.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
ProvisionableQuery	getProvisionableQuery()	Gets a provisionable query.
ProvisionableList	getProvisionablesByQuery(ProvisionableQuery provisionableQuery)	Gets a list of Provisionables matching the given provisionable query.
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Method Details

getProvisionableSearch

ProvisionableSearch getProvisionableSearch()

Gets a provisionable search.

Returns:

the provisionable search

Compliance:

mandatory - This method must be implemented.

getProvisionableSearchOrder

ProvisionableSearchOrder getProvisionableSearchOrder()

Gets a provisionable search order. The ProvisionableSearchOrder is supplied to a ProvisionableSearch to specify the ordering of results.

Returns:

the provisionable search order

Compliance:

mandatory - This method must be implemented.

getProvisionablesBySearch

ProvisionableSearchResults getProvisionablesBySearch(ProvisionableQuery provisionableQuery,
 ProvisionableSearch provisionableSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

provisionableQuery - the provisionable query

provisionableSearch - the provisionable search

Returns:

the returned search results

Throws:

NullArgumentException - provisionableQuery or provisionableSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - provisionableQuery or provisionableSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProvisionableQueryFromInspector

ProvisionableQuery getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector)

Gets a provisionable query from an inspector. The inspector is available from a ProvisionableSearchResults .

Parameters:

provisionableQueryInspector - a provisionable query inspector

Returns:

the provisionable query

Throws:

NullArgumentException - provisionableQueryInspector is null

UnsupportedException - provisionableQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.