OSID - osid.course.program.EnrollmentAdminSession Service Interface Definition

Interface	osid.course.program.EnrollmentAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Enrollments.` 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 an `Enrollment,` an `EnrollmentForm` is requested using `getEnrollmentFormFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `EnrollmentForm` 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 `EnrollmentForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `EnrollmentForm` corresponds to an attempted transaction. For updates, `EnrollmentForms` are requested to the `EnrollmentForm` `Id` that is to be updated using `getEnrollmentFormForUpdate().` Similarly, the `EnrollmentForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `EnrollmentForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Enrollments.` To unmap an `EnrollmentForm` from the current `CourseCatalog,` the `EnrollmentCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `EnrollmentForm` 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	canCreateEnrollments
Description	Tests if this user can create `Enrollments.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Enrollment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Enrollment` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEnrollmentWithRecordTypes
Description	Tests if this user can create a single `Enrollment` using the desired record types. While `CourseProgramManager.getEnrollmentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Enrollment.` Providing an empty array tests if an `Enrollment` can be created with no records.
Parameters	`osid.type.Type[]`	`enrollmentRecordTypes`	array of enrollment record types
Return	`boolean`		`true` if `Enrollment` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`enrollmentRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentFormForCreate
Description	Gets the course form for creating new enrollments. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`programOfferingId`	the `Id` for a `ProgramOffering`
	`osid.id.Id`	`resourceId`	the `Id` for a `Resource`
	`osid.type.Type[]`	`enrollmentRecordTypes`	array of enrollment record types
Return	`osid.course.program.EnrollmentForm`		the enrollment form
Errors	NOT_FOUND		`programOfferingId,` or `resourceId` is not found
	NULL_ARGUMENT		`programOfferingId, resourceId,` or `enrollmentRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested recod types
Compliance	`mandatory`		This method must be implemented.
Method	createEnrollment
Description	Creates a new `Enrollment.`
Parameters	`osid.course.program.EnrollmentForm`	`enrollmentForm`	the form for this `Enrollment`
Return	`osid.course.program.Enrollment`		the new `Enrollment`
Errors	ILLEGAL_STATE		`enrollmentForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`enrollmentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`enrollmentForm` did not originate from `getEnrollmentFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateEnrollments
Description	Tests if this user can update `Enrollments.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Enrollment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Enrollment` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentFormForUpdate
Description	Gets the enrollment form for updating an existing enrollment. A new enrollment form should be requested for each update transaction.
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment`
Return	`osid.course.program.EnrollmentForm`		the enrollment form
Errors	NOT_FOUND		`enrollmentId` is not found
	NULL_ARGUMENT		`enrollmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateEnrollment
Description	Updates an existing enrollment.
Parameters	`osid.course.program.EnrollmentForm`	`enrollmentForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`enrollmentForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`enrollmentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`enrollmentForm` did not originate from `getEnrollmentFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEnrollments
Description	Tests if this user can delete `Enrollments.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Enrollment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Enrollment` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEnrollment
Description	Deletes an `Enrollment.`
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment` to remove
Errors	NOT_FOUND		`enrollmentId` not found
	NULL_ARGUMENT		`enrollmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEnrollmentAliases
Description	Tests if this user can manage `Id` aliases for `Enrollments.` 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 `Enrollment` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEnrollment
Description	Adds an `Id` to an `Enrollment` for the purpose of creating compatibility. The primary `Id` of the `Enrollment` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another enrollment, it is reassigned to the given enrollment `Id.`
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of an `Enrollment`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`enrollmentId` not found
	NULL_ARGUMENT		`enrollmentId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.