Interface AssessmentPartSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AssessmentPartSearch
extends OsidSearch

The search interface for governing assessment part searches.

Method Summary

Modifier and Type	Method	Description
AssessmentPartSearchRecord	getAssessmentPartSearchRecord(Type assessmentPartSearchRecordType)	Gets the assessment part search record corresponding to the given assessment part search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAssessmentPartResults(AssessmentPartSearchOrder assessmentPartSearchOrder)	Specify an ordering to the search results.
void	searchAmongAssessmentParts(IdList bankIds)	Execute this search among the given list of assessment parts.

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

searchAmongAssessmentParts

void searchAmongAssessmentParts(IdList bankIds)

Execute this search among the given list of assessment parts.

Parameters:

bankIds - list of assessment parts

Throws:

NullArgumentException - bankIds is null

Compliance:

mandatory - This method must be implemented.

orderAssessmentPartResults

void orderAssessmentPartResults(AssessmentPartSearchOrder assessmentPartSearchOrder)

Specify an ordering to the search results.

Parameters:

assessmentPartSearchOrder - assessment part search order

Throws:

NullArgumentException - assessmentPartSearchOrder is null

UnsupportedException - assessmentPartSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAssessmentPartSearchRecord

AssessmentPartSearchRecord getAssessmentPartSearchRecord(Type assessmentPartSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

assessmentPartSearchRecordType - an assessment part search record type

Returns:

the assessment part search record

Throws:

NullArgumentException - assessmentPartSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentPartSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.