| Interface | osid.course.plan.PlanCourseCatalogAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | This session provides methods to re-assign   Adding a reference of a  | ||
| Method | canAssignPlans | ||
| Description | Tests if this user can alter plan/course catalog 
                    mappings. A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                     | ||
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignPlansToCourseCatalog | ||
| Description | Tests if this user can alter plan/course catalog 
                    mappings. A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                     | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Errors | NULL_ARGUMENT |  courseCatalogId is null  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCourseCatalogIds | ||
| Description | Gets a list of course catalogs including and under the given course catalog node in which any plan can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | osid.id.IdList | list of assignable course catalog  Ids  | |
| Errors | NULL_ARGUMENT |  courseCatalogId is null  | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCourseCatalogIdsForPlan | ||
| Description | Gets a list of course catalogs including and under the given course catalog node in which a specific plan can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| osid.id.Id | planId | the  Id of the Plan  | |
| Return | osid.id.IdList | list of assignable course catalog  Ids  | |
| Errors | NULL_ARGUMENT |  courseCatalogId or planId is null 
 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignPlanToCourseCatalog | ||
| Description | Adds an existing  | ||
| Parameters | osid.id.Id | planId | the  Id of the Plan  | 
| osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | |
| Errors | ALREADY_EXISTS |  planId is already assigned to courseCatalogId  | |
| NOT_FOUND |  planId or courseCatalogId not found | ||
| NULL_ARGUMENT |  planId or courseCatalogId is null 
 | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignPlanFromCourseCatalog | ||
| Description | Removes a  | ||
| Parameters | osid.id.Id | planId | the  Id of the Plan  | 
| osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | |
| Errors | NOT_FOUND |  planId or courseCatalogId not found or 
planId not assigned to courseCatalogId  | |
| NULL_ARGUMENT |  planId or courseCatalogId is null 
 | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignPlanToCourseCatalog | ||
| Description | Moves a  | ||
| Parameters | osid.id.Id | planId | the  Id of the Plan  | 
| osid.id.Id | fromCourseCatalogId | the  Id of the current CourseCatalog  | |
| osid.id.Id | toCourseCatalogId | the  Id of the destination CourseCatalog  | |
| Errors | NOT_FOUND |  planId, fromCourseCatalogId, or toCourseCatalogId 
not found or planId not mapped to 
fromCourseCatalogId  | |
| NULL_ARGUMENT |  planId, fromCourseCatalogId, or toCourseCatalogId 
is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |