org.osid.recipe

Interface ProcedureSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.recipe.ProcedureQuerySession

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

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

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.