OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.PlanSearch
Implementsosid.OsidSearch
Description

The search interface for governing plan searches.

MethodsearchAmongPlans
Description

Execute this search among the given list of plans.

Parametersosid.id.IdListplanIdslist of plans
ErrorsNULL_ARGUMENT planIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPlanResults
Description

Specify an ordering to the search results.

Parametersosid.course.plan.PlanSearchOrderplanSearchOrderplan search order
ErrorsNULL_ARGUMENT planSearchOrder is null
UNSUPPORTED planSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPlanSearchRecord
Description

Gets the plan search 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.PlanSearchRecordthe plan search record
ErrorsNULL_ARGUMENT planSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(planSearchRecordType) is false
CompliancemandatoryThis method must be implemented.