Interface InputSearchSession

All Superinterfaces:

AutoCloseable, Closeable, InputQuerySession, OsidSession, OsidSession

public interface InputSearchSession
extends InputQuerySession

This session provides methods for searching among Inputs . The search query is constructed using the InputQuery .

getInputsByQuery() is the basic search method and returns a list of Inputs . A more advanced search may be performed with getInputsBySearch() . It accepts a InputSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getInputsBySearch() returns a InputSearchResults that can be used to access the resulting InputList or be used to perform a search within the result set through InputSearch .

This session defines views that offer differing behaviors for searching.

• federated trigger view: searches include inputs in triggers of which this trigger is an ancestor in the trigger hierarchy
• isolated trigger view: searches are restricted to inputs in this trigger

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

Method Summary

Modifier and Type	Method	Description
InputQuery	getInputQueryFromInspector(InputQueryInspector inputQueryInspector)	Gets an input query from an inspector.
InputSearchResults	getInputsBySearch(InputQuery inputQuery, InputSearch inputSearch)	Gets the search results matching the given search query using the given search.
InputSearch	getInputSearch()	Gets an input search.
InputSearchOrder	getInputSearchOrder()	Gets an input search order.

Methods inherited from interface Closeable

close

Methods inherited from interface InputQuerySession

canSearchInputs, getInputQuery, getInputsByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchInputs()	Tests if this user can perform Input lookups.
InputQuery	getInputQuery()	Gets an input query.
InputList	getInputsByQuery(InputQuery inputQuery)	Gets a list of Inputs matching the given input query.
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	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

getInputSearch

InputSearch getInputSearch()

Gets an input search.

Returns:

the input search

Compliance:

mandatory - This method must be implemented.

getInputSearchOrder

InputSearchOrder getInputSearchOrder()

Gets an input search order. The InputSearchOrder is supplied to a InputSearch to specify the ordering of results.

Returns:

the input search order

Compliance:

mandatory - This method must be implemented.

getInputsBySearch

InputSearchResults getInputsBySearch(InputQuery inputQuery,
 InputSearch inputSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inputQuery - the input query

inputSearch - the input search

Returns:

the input search results

Throws:

NullArgumentException - inputQuery or inputSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inputQuery or inputSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getInputQueryFromInspector

InputQuery getInputQueryFromInspector(InputQueryInspector inputQueryInspector)

Gets an input query from an inspector. The inspector is available from a InputSearchResults .

Parameters:

inputQueryInspector - an input query inspector

Returns:

the input query

Throws:

NullArgumentException - inputQueryInspector is null

UnsupportedException - inputQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.