public interface SyllabusSearch extends OsidSearch
The search interface for governing syllabus searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSyllabi(IdList syllabusIds)
syllabusIds
- list of syllabiNullArgumentException
- syllabusIds
is
null
mandatory
- This method must be implemented. void orderSyllabusResults(SyllabusSearchOrder syllabusSearchOrder)
syllabusSearchOrder
- syllabus search orderNullArgumentException
- syllabusSearchOrder
is null
UnsupportedException
- syllabusSearchOrder
is not of this servicemandatory
- This method must be implemented. SyllabusSearchRecord getSyllabusSearchRecord(Type syllabusSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.syllabusSearchRecordType
- a syllabus search record typeNullArgumentException
- syllabusSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(syllabusSearchRecordType)
is
false
mandatory
- This method must be implemented.