Interface AssessmentSearchSession

All Superinterfaces:

AssessmentQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentSearchSession
extends AssessmentQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
AssessmentQuery	getAssessmentQueryFromInspector(AssessmentQueryInspector assessmentQueryInspector)	Gets an assessment query from an inspector.
AssessmentSearchResults	getAssessmentsBySearch(AssessmentQuery assessmentQuery, AssessmentSearch assessmentSearch)	Gets the search results matching the given search query using the given search.
AssessmentSearch	getAssessmentSearch()	Gets an assessment search.
AssessmentSearchOrder	getAssessmentSearchOrder()	Gets an assessment search order.

Methods inherited from interface AssessmentQuerySession

canSearchAssessments, getAssessmentQuery, getAssessmentsByQuery, getBank, getBankId, useFederatedBankView, useIsolatedBankView

Modifier and Type	Method	Description
boolean	canSearchAssessments()	Tests if this user can perform Assessment searches.
AssessmentQuery	getAssessmentQuery()	Gets an assessment query.
AssessmentList	getAssessmentsByQuery(AssessmentQuery assessmentQuery)	Gets a list of Assessments matching the given assessment query.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
void	useFederatedBankView()	Federates the view for methods in this session.
void	useIsolatedBankView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

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

getAssessmentSearch

AssessmentSearch getAssessmentSearch()

Gets an assessment search.

Returns:

the assessment search

Compliance:

mandatory - This method must be implemented.

getAssessmentSearchOrder

AssessmentSearchOrder getAssessmentSearchOrder()

Gets an assessment search order. The AssessmentSearchOrder is supplied to an AssessmentSearch to specify the ordering of results.

Returns:

the assessment search order

Compliance:

mandatory - This method must be implemented.

getAssessmentsBySearch

AssessmentSearchResults getAssessmentsBySearch(AssessmentQuery assessmentQuery,
 AssessmentSearch assessmentSearch)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

assessmentQuery - the assessment query

assessmentSearch - the assessment search

Returns:

the search results

Throws:

NullArgumentException - assessmentQuery or assessmentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - assessmentQuery or assessmentSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAssessmentQueryFromInspector

AssessmentQuery getAssessmentQueryFromInspector(AssessmentQueryInspector assessmentQueryInspector)

Gets an assessment query from an inspector. The inspector is available from an AssessmentSearchResults .

Parameters:

assessmentQueryInspector - an assessment query inspector

Returns:

the assessment query

Throws:

NullArgumentException - assessmentQueryInspector is null

UnsupportedException - assessmentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.