OSID Logo
OSID Specifications
course plan package
Version 3.1.0
Interfaceosid.course.plan.PlanSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.plan.PlanSearchSession
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.PlanList the plan list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetPlanQueryInspector
Description

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

Returnosid.course.plan.PlanQueryInspector the plan query inspector
Compliancemandatory This 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.TypeplanSearchRecordType a plan search record type
Returnosid.course.plan.records.PlanSearchResultsRecord the plan search record
ErrorsNULL_ARGUMENT planSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(planSearchRecordType) is false
Compliancemandatory This method must be implemented.