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

Interface	osid.course.plan.PlanSearchSession
Implements	`osid.course.plan.PlanQuerySession`
Used By	`osid.course.plan.CoursePlanManager`
Used By	`osid.course.plan.CoursePlanProxyManager`
Description	This session provides methods for searching `Plans` . The search query is constructed using the `PlanQuery` . The plan record `Type` also specifies the record for the plan query. `getPlansByQuery()` is the basic search method and returns a list of `CourseCatalog` elements. A more advanced search may be performed with `getPlansBySearch()` . It accepts a `PlanSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPlansBySearch()` returns a `PlanSearchResults` that can be used to access the resulting `PlanList` or be used to perform a search within the result set through `PlanSearch` . Plans may have a query record indicated by their respective record types. The query record is accessed via the `PlanQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getPlanSearch
Description	Gets a plan search.
Return	`osid.course.plan.PlanSearch`		the plan search
Compliance	`mandatory`		This method must be implemented.
Method	getPlanSearchOrder
Description	Gets a plan search order. The `PlanSearchOrder` is supplied to a `PlanSearch` to specify the ordering of results.
Return	`osid.course.plan.PlanSearchOrder`		the plan search order interface
Compliance	`mandatory`		This method must be implemented.
Method	getPlansBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.course.plan.PlanQuery`	`planQuery`	the plan query
Parameters	`osid.course.plan.PlanSearch`	`planSearch`	the plan search
Return	`osid.course.plan.PlanSearchResults`		the plan search results
Errors	NULL_ARGUMENT		`planQuery` or `planSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`planQuery` or `planSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPlanQueryFromInspector
Description	Gets a plan query from an inspector. The inspector is available from an `PlanSearchResults` .
Parameters	`osid.course.plan.PlanQueryInspector`	`planQueryInspector`	a plan query inspector
Return	`osid.course.plan.PlanQuery`		the plan query
Errors	NULL_ARGUMENT		`planQueryInspector` is `null`
Errors	UNSUPPORTED		`planQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.