Interface AssessmentEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AssessmentEntrySearch
extends OsidSearch

The search interface for governing assessment entry searches.

Method Summary

Modifier and Type	Method	Description
AssessmentEntrySearchRecord	getAssessmentEntrySearchRecord(Type assessmentEntrySearchRecordType)	Gets the assessment entry search record corresponding to the given assessment entry search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAssessmentEntryResults(AssessmentEntrySearchOrder assessmentEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongAssessmentEntries(IdList assessmentEntryIds)	Execute this search among the given list of assessment entries.

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

searchAmongAssessmentEntries

void searchAmongAssessmentEntries(IdList assessmentEntryIds)

Execute this search among the given list of assessment entries.

Parameters:

assessmentEntryIds - list of assessment entry Ids

Throws:

NullArgumentException - assessmentEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderAssessmentEntryResults

void orderAssessmentEntryResults(AssessmentEntrySearchOrder assessmentEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

assessmentEntrySearchOrder - assessment entry search order

Throws:

NullArgumentException - assessmentEntrySearchOrder is null

UnsupportedException - assessmentEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAssessmentEntrySearchRecord

AssessmentEntrySearchRecord getAssessmentEntrySearchRecord(Type assessmentEntrySearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

assessmentEntrySearchRecordType - an assessment entry search record type

Returns:

the assessment entry search record

Throws:

NullArgumentException - assessmentEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.