org.osid.control

Interface InputSearchSession

All Superinterfaces:

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

public interface InputSearchSession
extends InputQuerySession

This session provides methods for searching among Input objects. 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

Methods

Modifier and Type	Method and 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 org.osid.control.InputQuerySession

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

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

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.