Interface ProcedureSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProcedureQuerySession

public interface ProcedureSearchSession
extends ProcedureQuerySession

This session provides methods for searching Procedure objects. The search query is constructed using the ProcedureQuery. The procedure record Type also specifies the record for the procedure query.

getProceduresByQuery() is the basic search method and returns a list of Cookbook elements. A more advanced search may be performed with getProceduresBySearch(). It accepts a ProcedureSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProceduresBySearch() returns a ProcedureSearchResults that can be used to access the resulting ProcedureList or be used to perform a search within the result set through ProcedureSearch.

Procedures may have a query record indicated by their respective record types. The query record is accessed via the ProcedureQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
ProcedureQuery	getProcedureQueryFromInspector(ProcedureQueryInspector procedureQueryInspector)	Gets a procedure query from an inspector.
ProcedureSearchResults	getProceduresBySearch(ProcedureQuery procedureQuery, ProcedureSearch procedureSearch)	Gets the search results matching the given search.
ProcedureSearch	getProcedureSearch()	Gets a procedure search.
ProcedureSearchOrder	getProcedureSearchOrder()	Gets a procedure 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 ProcedureQuerySession

canSearchProcedures, getCookbook, getCookbookId, getProcedureQuery, getProceduresByQuery, useFederatedCookbookView, useIsolatedCookbookView

Modifier and Type	Method	Description
boolean	canSearchProcedures()	Tests if this user can perform susbcription searches.
Cookbook	getCookbook()	Gets the Cookbook associated with this session.
Id	getCookbookId()	Gets the Cookbook Id associated with this session.
ProcedureQuery	getProcedureQuery()	Gets a procedure query.
ProcedureList	getProceduresByQuery(ProcedureQuery procedureQuery)	Gets a list of procedures matching the given procedure query.
void	useFederatedCookbookView()	Federates the view for methods in this session.
void	useIsolatedCookbookView()	Isolates the view for methods in this session.

Method Details

getProcedureSearch

ProcedureSearch getProcedureSearch()

Gets a procedure search.

Returns:

the procedure search

Compliance:

mandatory - This method must be implemented.

getProcedureSearchOrder

ProcedureSearchOrder getProcedureSearchOrder()

Gets a procedure search order. The ProcedureSearchOrder is supplied to a ProcedureSearch to specify the ordering of results.

Returns:

the procedure search order interface

Compliance:

mandatory - This method must be implemented.

getProceduresBySearch

ProcedureSearchResults getProceduresBySearch(ProcedureQuery procedureQuery,
 ProcedureSearch procedureSearch)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

procedureQuery - the procedure query

procedureSearch - the procedure search

Returns:

the procedure search results

Throws:

NullArgumentException - procedureQuery or procedureSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - procedureQuery or procedureSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProcedureQueryFromInspector

ProcedureQuery getProcedureQueryFromInspector(ProcedureQueryInspector procedureQueryInspector)

Gets a procedure query from an inspector. The inspector is available from a ProcedureSearchResults.

Parameters:

procedureQueryInspector - a procedure query inspector

Returns:

the procedure query

Throws:

NullArgumentException - procedureQueryInspector is null

UnsupportedException - procedureQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.