Interface SyllabusSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SyllabusSearch
extends OsidSearch

The search interface for governing syllabus searches.

Method Summary

Modifier and Type	Method	Description
SyllabusSearchRecord	getSyllabusSearchRecord(Type syllabusSearchRecordType)	Gets the syllabus search record corresponding to the given syllabus search record Type.
void	orderSyllabusResults(SyllabusSearchOrder syllabusSearchOrder)	Specify an ordering to the search results.
void	searchAmongSyllabi(IdList syllabusIds)	Execute this search among the given list of syllabi.

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

searchAmongSyllabi

void searchAmongSyllabi(IdList syllabusIds)

Execute this search among the given list of syllabi.

Parameters:

syllabusIds - list of syllabi

Throws:

NullArgumentException - syllabusIds is null

Compliance:

mandatory - This method must be implemented.

orderSyllabusResults

void orderSyllabusResults(SyllabusSearchOrder syllabusSearchOrder)

Specify an ordering to the search results.

Parameters:

syllabusSearchOrder - syllabus search order

Throws:

NullArgumentException - syllabusSearchOrder is null

UnsupportedException - syllabusSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSyllabusSearchRecord

SyllabusSearchRecord getSyllabusSearchRecord(Type syllabusSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

syllabusSearchRecordType - a syllabus search record type

Returns:

the syllabus search record

Throws:

NullArgumentException - syllabusSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(syllabusSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.