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

Interface	osid.course.plan.LessonAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Lessons.` 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 `Lesson,` a `LessonForm` is requested using `getLessonFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `LessonForm` 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 `LessonForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `LessonForm` corresponds to an attempted transaction. For updates, `LessonForms` are requested to the `Lesson` `Id` that is to be updated using `getLessonForUpdate().` Similarly, the `LessonForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `LessonForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Lessons.` To unmap a `Lesson` from the current `CourseCatalog,` the `LessonCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `Lesson` 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	canCreateLessons
Description	Tests if this user can create `Lessons.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Lesson` 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 `Lesson` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateLessonWithRecordTypes
Description	Tests if this user can create a single `Lesson` using the desired record types. While `CoursePlanManager.getLessonRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Lesson.` Providing an empty array tests if a `Lesson` can be created with no records.
Parameters	`osid.type.Type[]`	`lessonRecordTypes`	array of lesson record types
Return	`boolean`		`true` if `Lesson` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`lessonRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLessonFormForCreate
Description	Gets the lesson form for creating new lessons. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
	`osid.id.Id`	`docetId`	a docet `Id`
	`osid.type.Type[]`	`lessonRecordTypes`	array of lesson record types
Return	`osid.course.plan.LessonForm`		the lesson form
Errors	NOT_FOUND		`planId` or `docetId` is not found
	NULL_ARGUMENT		`planId, docetId` or `lessonRecordTypes` 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	createLesson
Description	Creates a new `Lesson.`
Parameters	`osid.course.plan.LessonForm`	`lessonForm`	the form for this `Lesson`
Return	`osid.course.plan.Lesson`		the new `Lesson`
Errors	ILLEGAL_STATE		`lessonForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`lessonForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`lessonForm` did not originate from `getLessonFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateLessons
Description	Tests if this user can update `Lessons.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Lesson` 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 `Lesson` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLessonFormForUpdate
Description	Gets the lesson form for updating an existing lesson. A new lesson form should be requested for each update transaction.
Parameters	`osid.id.Id`	`lessonId`	the `Id` of the `Lesson`
Return	`osid.course.plan.LessonForm`		the lesson form
Errors	NOT_FOUND		`lessonId` is not found
	NULL_ARGUMENT		`lessonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateLesson
Description	Updates an existing lesson.
Parameters	`osid.course.plan.LessonForm`	`lessonForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`lessonForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`lessonForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`lessonForm` did not originate from `getLessonFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteLessons
Description	Tests if this user can delete `Lessons` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Lesson` 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 `Lesson` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteLesson
Description	Deletes a `Lesson.`
Parameters	`osid.id.Id`	`lessonId`	the `Id` of the `Lesson` to remove
Errors	NOT_FOUND		`lessonId` not found
	NULL_ARGUMENT		`lessonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageLessonAliases
Description	Tests if this user can manage `Id` aliases for `Lessons.` 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 `Lesson` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasLesson
Description	Adds an `Id` to a `Lesson` for the purpose of creating compatibility. The primary `Id` of the `Lesson` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another lesson, it is reassigned to the given lesson `Id.`
Parameters	`osid.id.Id`	`lessonId`	the `Id` of a `Lesson`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`lessonId` not found
	NULL_ARGUMENT		`lessonId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.