Interface InstructionSearchSession

All Superinterfaces:

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

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

close

Methods inherited from interface InstructionQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchInstructions()	Tests if this user can perform Instruction lookups.
Engine	getEngine()	Gets the Engine associated with this session.
Id	getEngineId()	Gets the Engine Id associated with this session.
InstructionQuery	getInstructionQuery()	Gets an instruction query.
InstructionList	getInstructionsByQuery(InstructionQuery instructionQuery)	Gets a list of Instructions matching the given instruction query.
void	useFederatedEngineView()	Federates the view for methods in this session.
void	useIsolatedEngineView()	Isolates the view for methods in this session.

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.

Method Details

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.