Interface AssessmentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AssessmentSearch
extends OsidSearch

AssessmentSearch defines the interface for specifying assessment search options.

Method Summary

Modifier and Type	Method	Description
AssessmentSearchRecord	getAssessmentSearchRecord(Type assessmentSearchRecordType)	Gets the assessment search record corresponding to the given assessment search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAssessmentResults(AssessmentSearchOrder assessmentSearchOrder)	Specify an ordering to the search results.
void	searchAmongAssessments(IdList assessmentIds)	Execute this search among the given list of assessments.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAssessments

void searchAmongAssessments(IdList assessmentIds)

Execute this search among the given list of assessments.

Parameters:

assessmentIds - list of assessments

Throws:

NullArgumentException - assessmentIds is null

Compliance:

mandatory - This method must be implemented.

orderAssessmentResults

void orderAssessmentResults(AssessmentSearchOrder assessmentSearchOrder)

Specify an ordering to the search results.

Parameters:

assessmentSearchOrder - assessment search order

Throws:

NullArgumentException - assessmentSearchOrder is null

UnsupportedException - assessmentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAssessmentSearchRecord

AssessmentSearchRecord getAssessmentSearchRecord(Type assessmentSearchRecordType)
                                          throws OperationFailedException

Gets the assessment search record corresponding to the given assessment search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

assessmentSearchRecordType - an assessment search record type

Returns:

the assessment search record

Throws:

NullArgumentException - assessmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.