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

Interface	osid.course.plan.PlanLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving plans. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated course catalog view: All plan methods in this session operate, retrieve and pertain to plans defined explicitly in the current course catalog. Using an isolated view is useful for managing plans with the `PlanAdminSession.` federated course catalog view: All plan lookup methods in this session operate, retrieve and pertain to all plans defined in this course catalog and any other course catalogs implicitly available in this course catalog through course catalog inheritence. effective plan view: All plan lookup methods return plans where the current date falls in between the effective dates inclusive. any plan view: Plans of any effective date are returned from methods. The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupPlans
Description	Tests if this user can lookup plans. 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 opt not to offer these operations.
Return	`boolean`		`false` if plan lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePlanView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryPlanView
Description	A complete view of the `Plan` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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	useEffectivePlanView
Description	Only plans whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectivePlanView
Description	All plans of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getPlan
Description	Gets the `Plan` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Plan` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Plan` and retained for compatibility. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan` to retrieve
Return	`osid.course.plan.Plan`		the returned `Plan`
Errors	NOT_FOUND		no `Plan` found with the given `Id`
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansByIds
Description	Gets a `PlanList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the plans specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible plans may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.IdList`	`planIds`	the list of `Ids` to retrieve
Return	`osid.course.plan.PlanList`		the returned `Plan list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`planIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansByGenusType
Description	Gets a `PlanList` corresponding to the given plan genus `Type` which does not include plans of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.type.Type`	`planGenusType`	a plan genus type
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	NULL_ARGUMENT		`planGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansByParentGenusType
Description	Gets a `PlanList` corresponding to the given plan genus `Type` and include any additional plans with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.type.Type`	`planGenusType`	a plan genus type
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	NULL_ARGUMENT		`planGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansByRecordType
Description	Gets a `PlanList` containing the given plan record `Type.` In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.type.Type`	`planRecordType`	a plan record type
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	NULL_ARGUMENT		`planRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansOnDate
Description	Gets a `PlanList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansForSyllabus
Description	Gets a `PlanList` for the given syllabus `Id.` In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansForSyllabusOnDate
Description	Gets a `PlanList` for a syllabus effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`syllabusId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansForCourseOffering
Description	Gets a `PlanList` for the given course offering `Id.` In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansForCourseOfferingOnDate
Description	Gets a `PlanList` for a course offering effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`courseOfferingId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansForSyllabusAndCourseOffering
Description	Gets a `PlanList` for the given syllabus `and course offering.` In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	NULL_ARGUMENT		`syllabusId` or `courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlansForSyllabusAndCourseOfferingOnDate
Description	Gets a `PlanList` for a syllabus and course offering effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.plan.PlanList`		the returned `Plan` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`syllabusId, courseOfferingId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPlans
Description	Gets all plans. In plenary mode, the returned list contains all known plans or an error results. Otherwise, the returned list may contain only those plans that are accessible through this session. In effective mode, plans are returned that are currently effective. In any effective mode, effective plans and those currently expired are returned.
Return	`osid.course.plan.PlanList`		a list of plans
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.