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

Interface	osid.course.plan.PlanQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.course.plan.PlanSearchSession`
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 lesson record `Type` also specifies the record for the lesson query. 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	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchPlans
Description	Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include plans in course catalogs which are children of this course catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPlanQuery
Description	Gets a plan query.
Return	`osid.course.plan.PlanQuery`		the plan query
Compliance	`mandatory`		This method must be implemented.
Method	getPlansByQuery
Description	Gets a list of plans matching the given plan query.
Parameters	`osid.course.plan.PlanQuery`	`planQuery`	the plan query
Return	`osid.course.plan.PlanList`		the returned `PlanList`
Errors	NULL_ARGUMENT		`planQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`planQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.