org.osid.rules.check

Interface InstructionSearchSession

All Superinterfaces:

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

public interface InstructionSearchSession
extends InstructionQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated engine view: searches include instructions in engines of which this engine is an ancestor in the engine hierarchy
• isolated engine view: searches are restricted to instructions in this engine

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

Method Summary

Methods

Modifier and Type	Method and Description
InstructionQuery	getInstructionQueryFromInspector(InstructionQueryInspector instructionQueryInspector) Gets an instruction query.
InstructionSearchResults	getInstructionsBySearch(InstructionQuery instructionQuery, InstructionSearch instructionSearch) Gets the search results matching the given search query using the given search.
InstructionSearch	getInstructionSearch() Gets an instruction search.
InstructionSearchOrder	getInstructionSearchOrder() Gets an instruction search order.

Methods inherited from interface org.osid.rules.check.InstructionQuerySession

canSearchInstructions, getEngine, getEngineId, getInstructionQuery, getInstructionsByQuery, useFederatedEngineView, useIsolatedEngineView

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

getInstructionSearch

InstructionSearch getInstructionSearch()

Gets an instruction search.

Returns:

the instruction search

Compliance:

mandatory - This method must be implemented.

getInstructionSearchOrder

InstructionSearchOrder getInstructionSearchOrder()

Gets an instruction search order. The InstructionSearchOrder is supplied to an InstructionSearch to specify the ordering of results.

Returns:

the instruction search order

Compliance:

mandatory - This method must be implemented.

getInstructionsBySearch

InstructionSearchResults getInstructionsBySearch(InstructionQuery instructionQuery,
                                               InstructionSearch instructionSearch)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

instructionQuery - the instruction query

instructionSearch - the instruction search

Returns:

the instruction search results

Throws:

NullArgumentException - instructionQuery or instructionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - instructionQuery or instructionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getInstructionQueryFromInspector

InstructionQuery getInstructionQueryFromInspector(InstructionQueryInspector instructionQueryInspector)

Gets an instruction query. from an inspector. The inspector is available from an InstructionSearchResults.

Parameters:

instructionQueryInspector - an instruction query inspector

Returns:

the instruction query

Throws:

NullArgumentException - instructionQueryInspector is null

UnsupportedException - instructionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.