OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.PlanSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetPlans
Description

Gets the plan list resulting from a search.

Returnosid.course.plan.PlanListthe plan list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPlanQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.course.plan.PlanQueryInspectorthe plan query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPlanSearchResultsRecord
Description

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

Parametersosid.type.TypeplanSearchRecordTypea plan search record type
Returnosid.course.plan.records.PlanSearchResultsRecordthe plan search record
ErrorsNULL_ARGUMENT planSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(planSearchRecordType) is false
CompliancemandatoryThis method must be implemented.