OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.DocetSearchSession
Implementsosid.course.syllabus.DocetQuerySession
Description

This session provides methods for searching Docet objects. The search query is constructed using the DocetQuery. The docet record Type also specifies the record for the docet query.

getDocetsByQuery() is the basic search method and returns a list of Docet elements. A more advanced search may be performed with getDocetsBySearch(). It accepts an DocetSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDocetsBySearch() returns an DocetSearchResults that can be used to access the resulting DocetList or be used to perform a search within the result set through DocetSearch.

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

MethodgetDocetSearch
Description

Gets a docet search.

Returnosid.course.syllabus.DocetSearchthe docet search
CompliancemandatoryThis method must be implemented.
MethodgetDocetSearchOrder
Description

Gets a docet search order. The DocetSearchOrder is supplied to an DocetSearch to specify the ordering of results.

Returnosid.course.syllabus.DocetSearchOrderthe docet search order
CompliancemandatoryThis method must be implemented.
MethodgetDocetsBySearch
Description

Gets the search results matching the given search.

Parametersosid.course.syllabus.DocetQuerydocetQuerythe docet query
osid.course.syllabus.DocetSearchdocetSearchthe docet search
Returnosid.course.syllabus.DocetSearchResultsthe docet search results
ErrorsNULL_ARGUMENT docetQuery or docetSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED docetQuery or docetSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDocetQueryFromInspector
Description

Gets a docet query from an inspector. The inspector is available from an DocetSearchResults.

Parametersosid.course.syllabus.DocetQueryInspectordocetQueryInspectora docet query inspector
Returnosid.course.syllabus.DocetQuerythe course catalog query
ErrorsNULL_ARGUMENT docetQueryInspector is null
UNSUPPORTED docetQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.