Interface | osid.course.plan.PlanLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving plans. This lookup session defines several views:
The methods | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
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 | ||
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 | ||
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 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 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 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 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 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 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 |
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 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 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 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 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 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 | |
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 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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |