OSID - osid.course.plan.PlanSearch Service Interface Definition

Interface	osid.course.plan.PlanSearch
Implements	`osid.OsidSearch`
Used By	`osid.course.plan.PlanSearchSession`
Description	The search interface for governing plan searches.
Method	searchAmongPlans
Description	Execute this search among the given list of plans.
Parameters	`osid.id.IdList`	`planIds`	list of plans
Errors	NULL_ARGUMENT		`planIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderPlanResults
Description	Specify an ordering to the search results.
Parameters	`osid.course.plan.PlanSearchOrder`	`planSearchOrder`	plan search order
Errors	NULL_ARGUMENT		`planSearchOrder` is `null`
Errors	UNSUPPORTED		`planSearchOrder` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPlanSearchRecord
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.
Parameters	`osid.type.Type`	`planSearchRecordType`	a plan search record type
Return	`osid.course.plan.records.PlanSearchRecord`		the plan search record
Errors	NULL_ARGUMENT		`planSearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(planSearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.