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

Interface	osid.course.plan.PlanAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Plans.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Plan,` a `PlanForm` is requested using `getPlanFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PlanForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `PlanForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PlanForm` corresponds to an attempted transaction. For updates, `PlanForms` are requested to the `PlanForm` `Id` that is to be updated using `getPlanFormForUpdate().` Similarly, the `PlanForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PlanForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Plans.` To unmap a `Plan` from the current `CourseCatalog,` the `PlanCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `Plan` itself thus removing it from all known `CourseCatalog` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreatePlans
Description	Tests if this user can create plans. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Plan` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Plan` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePlanWithRecordTypes
Description	Tests if this user can create a single `Plan` using the desired record types. While `CoursePlanManager.getPlanRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Plan.` Providing an empty array tests if a `Plan` can be created with no records.
Parameters	`osid.type.Type[]`	`planRecordTypes`	array of plan record types
Return	`boolean`		`true` if `Plan` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`planRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPlanFormForCreate
Description	Gets the plan form for creating new plans. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.type.Type[]`	`planRecordTypes`	array of plan record types
Return	`osid.course.plan.PlanForm`		the plan form
Errors	NOT_FOUND		`syllabusId` or `courseOfferingId` is not found
	NULL_ARGUMENT		`syllabusId, courseOfferingId,` or `planRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createPlan
Description	Creates a new `Plan.`
Parameters	`osid.course.plan.PlanForm`	`planForm`	the form for this `Plan`
Return	`osid.course.plan.Plan`		the new `Plan`
Errors	ILLEGAL_STATE		`planForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`planForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`planForm` did not originate from `getPlanFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePlans
Description	Tests if this user can update plans. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Plan` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Plan` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPlanFormForUpdate
Description	Gets the plan form for updating an existing plan. A new plan form should be requested for each update transaction.
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan`
Return	`osid.course.plan.PlanForm`		the plan form
Errors	NOT_FOUND		`planId` is not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePlan
Description	Updates an existing plan.
Parameters	`osid.course.plan.PlanForm`	`planForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`planForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`planForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`planForm` did not originate from `getPlanFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePlans
Description	Tests if this user can delete plans. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Plan` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Plan` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePlan
Description	Deletes a `Plan.`
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan` to remove
Errors	NOT_FOUND		`planId` not found
	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePlanAliases
Description	Tests if this user can manage `Id` aliases for `Plans.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Plan` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPlan
Description	Adds an `Id` to a `Plan` for the purpose of creating compatibility. The primary `Id` of the `Plan` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another plan, it is reassigned to the given plan `Id.`
Parameters	`osid.id.Id`	`planId`	the `Id` of a `Plan`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`planId` not found
	NULL_ARGUMENT		`planId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.