Interface AssessmentTakenSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AssessmentTakenSearch
extends OsidSearch

AssessmentTakenSearch defines the interface for specifying assessment search options.

Method Summary

Modifier and Type	Method	Description
AssessmentTakenSearchRecord	getAssessmentTakenSearchRecord(Type assessmentTakenSearchRecordType)	Gets the assessment taken search record corresponding to the given assessment taken search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAssessmentTakenResults(AssessmentTakenSearchOrder assessmentTakenSearchOrder)	Specify an ordering to the search results.
void	searchAmongAssessmentsTaken(IdList assessmentTakenIds)	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

searchAmongAssessmentsTaken

void searchAmongAssessmentsTaken(IdList assessmentTakenIds)

Execute this search among the given list of assessments.

Parameters:

assessmentTakenIds - list of assessments taken

Throws:

NullArgumentException - assessmentTakenIds is null

Compliance:

mandatory - This method must be implemented.

orderAssessmentTakenResults

void orderAssessmentTakenResults(AssessmentTakenSearchOrder assessmentTakenSearchOrder)

Specify an ordering to the search results.

Parameters:

assessmentTakenSearchOrder - assessment offered search order

Throws:

NullArgumentException - assessmentTakenSearchOrder is null

UnsupportedException - assessmentTakenSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAssessmentTakenSearchRecord

AssessmentTakenSearchRecord getAssessmentTakenSearchRecord(Type assessmentTakenSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

assessmentTakenSearchRecordType - an assessment taken search record type

Returns:

the assessment taken search record

Throws:

NullArgumentException - assessmentTakenSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentTakenSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.