OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.SyllabusSearchSession
Implementsosid.course.syllabus.SyllabusQuerySession
Description

This session provides methods for searching Syllabus objects. The search query is constructed using the SyllabusQuery. The syllabus record Type also specifies the record for the syllabus query.

getSyllabiByQuery() is the basic search method and returns a list of CourseCatalog elements. A more advanced search may be performed with getSyllabiBySearch(). It accepts a SyllabusSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSyllabiBySearch() returns a SyllabusSearchResults that can be used to access the resulting SyllabusList or be used to perform a search within the result set through SyllabusSearch.

Syllabi may have a query record indicated by their respective record types. The query record is accessed via the SyllabusQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetSyllabusSearch
Description

Gets a syllabus search.

Returnosid.course.syllabus.SyllabusSearchthe syllabus search
CompliancemandatoryThis method must be implemented.
MethodgetSyllabusSearchOrder
Description

Gets a syllabus search order. The SyllabusSearchOrder is supplied to a SyllabusSearch to specify the ordering of results.

Returnosid.course.syllabus.SyllabusSearchOrderthe syllabus search order interface
CompliancemandatoryThis method must be implemented.
MethodgetSyllabiBySearch
Description

Gets the search results matching the given search.

Parametersosid.course.syllabus.SyllabusQuerysyllabusQuerythe syllabus query
osid.course.syllabus.SyllabusSearchsyllabusSearchthe syllabus search
Returnosid.course.syllabus.SyllabusSearchResultsthe syllabus search results
ErrorsNULL_ARGUMENT syllabusQuery or syllabusSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED syllabusQuery or syllabusSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSyllabusQueryFromInspector
Description

Gets a syllabus query from an inspector. The inspector is available from a SyllabusSearchResults.

Parametersosid.course.syllabus.SyllabusQueryInspectorsyllabusQueryInspectora syllabus query inspector
Returnosid.course.syllabus.SyllabusQuerythe syllabus query
ErrorsNULL_ARGUMENT syllabusQueryInspector is null
UNSUPPORTED syllabusQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.