Interface ItemSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ItemQuerySession, OsidSession, OsidSession

public interface ItemSearchSession
extends ItemQuerySession

This session provides methods for searching Item objects. The search query is constructed using the ItemQuery . The assessment item record Type also specifies the query record for the assessment item query.

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

This session defines views that offer differing behaviors for searching.

• federated assessment bank view: searches include assessment items in assessment banks of which this assessment bank is an ancestor in the assessment bank hierarchy
• isolated bank view: searches are restricted to assessment items in this assessment bank

Assessment items may have a query record indicated by their respective record types. The query record is accessed via the ItemQuery .

Method Summary

Modifier and Type	Method	Description
ItemQuery	getItemQueryFromInspector(ItemQueryInspector itemQueryInspector)	Gets an item query from an inspector.
ItemSearchResults	getItemsBySearch(ItemQuery itemQuery, ItemSearch itemSearch)	Gets the search results matching the given search query using the given search.
ItemSearch	getItemSearch()	Gets an assessment item search.
ItemSearchOrder	getItemSearchOrder()	Gets an assessment item search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ItemQuerySession

canSearchItems, getBank, getBankId, getItemQuery, getItemsByQuery, useFederatedBankView, useIsolatedBankView

Modifier and Type	Method	Description
boolean	canSearchItems()	Tests if this user can perform Item searches.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
ItemQuery	getItemQuery()	Gets an assessment item query.
ItemList	getItemsByQuery(ItemQuery itemQuery)	Gets a list of Items matching the given item query.
void	useFederatedBankView()	Federates the view for methods in this session.
void	useIsolatedBankView()	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

getItemSearch

ItemSearch getItemSearch()

Gets an assessment item search.

Returns:

the assessment item search

Compliance:

mandatory - This method must be implemented.

getItemSearchOrder

ItemSearchOrder getItemSearchOrder()

Gets an assessment item search order. The ItemSearchOrder is supplied to an ItemSearch to specify the ordering of results.

Returns:

the assessment item search order

Compliance:

mandatory - This method must be implemented.

getItemsBySearch

ItemSearchResults getItemsBySearch(ItemQuery itemQuery,
 ItemSearch itemSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

itemQuery - the item query

itemSearch - the item search

Returns:

the returned search results

Throws:

NullArgumentException - itemQuery or itemSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - itemSearch or itemQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getItemQueryFromInspector

ItemQuery getItemQueryFromInspector(ItemQueryInspector itemQueryInspector)

Gets an item query from an inspector. The inspector is available from an ItemSearchResults .

Parameters:

itemQueryInspector - a query inspector

Returns:

the item query

Throws:

NullArgumentException - itemQueryInspector is null

UnsupportedException - itemQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.