Interface AssessmentOfferedSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AssessmentOfferedSearch
extends OsidSearch

AssessmentOfferedSearch defines the interface for specifying assessment search options.

Method Summary

Modifier and Type	Method	Description
AssessmentOfferedSearchRecord	getAssessmentOfferedSearchRecord(Type assessmentOfferedSearchRecordType)	Gets the assessment search record corresponding to the given assessment offered search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAssessmentOfferedResults(AssessmentOfferedSearchOrder assessmentOfferedSearchOrder)	Specify an ordering to the search results.
void	searchAmongAssessmentsOffered(IdList assessmentOffreredIds)	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

searchAmongAssessmentsOffered

void searchAmongAssessmentsOffered(IdList assessmentOffreredIds)

Execute this search among the given list of assessments.

Parameters:

assessmentOffreredIds - list of assessments offered

Throws:

NullArgumentException - assessmentOfferedIds is null

Compliance:

mandatory - This method must be implemented.

orderAssessmentOfferedResults

void orderAssessmentOfferedResults(AssessmentOfferedSearchOrder assessmentOfferedSearchOrder)

Specify an ordering to the search results.

Parameters:

assessmentOfferedSearchOrder - assessment offered search order

Throws:

NullArgumentException - assessmentOfferedSearchOrder is null

UnsupportedException - assessmentOfferedSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAssessmentOfferedSearchRecord

AssessmentOfferedSearchRecord getAssessmentOfferedSearchRecord(Type assessmentOfferedSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

assessmentOfferedSearchRecordType - an assessment offered search record type

Returns:

the assessment offered search

Throws:

NullArgumentException - assessmentOfferedSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentOfferedSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.