OSID - osid.course.registration.CourseRegistrationAdminSession Service Interface Definition

Interface	osid.course.registration.CourseRegistrationAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.registration.batch.CourseRegistrationBatchAdminSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session creates, updates, and deletes `CourseRegistrat` ions. 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 `CourseRegistra` tion, a `CourseRegistratio` nForm is requested using `getCourseRegistrationFormForCre` ate() specifying the desired registration, course offering, resource, and record `Types` or none if no record `Types` are needed. The returned `CourseRegistratio` nForm 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 `CourseRegistratio` nForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CourseRegistratio` nForm corresponds to an attempted transaction. For updates, `CourseRegistration` Forms are requested to the `CourseRegistr` ation `Id` that is to be updated using `getCourseRegistrationFormForUpda` te(). Similarly, the `CourseRegistratio` nForm has metadata about the data that can be updated and it can perform validation before submitting the update. The `CourseRegistratio` nForm can only be used once for a successful update and cannot be reused. The delete operations delete `CourseRegistrat` ions. To unmap a `CourseRegistr` ation from the current `CourseCatalog` , the `CourseRegistrationCourseCatalogAssignmentSe` ssion should be used. These delete operations attempt to remove the `CourseRegistr` ation 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	canCreateCourseRegistrations
Description	Tests if this user can create `CourseRegistrat` ions. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CourseRegistr` ation will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `CourseRegistration` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCourseRegistrationWithRecordTypes
Description	Tests if this user can create a single `CourseRegistra` tion using the desired record types. While `CourseRegistrationManager.getCourseRegistrationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CourseRegistra` tion. Providing an empty array tests if a `CourseRegistrat` ion can be created with no records.
Parameters	`osid.type.Type[]`	`courseRegistrationRecordTypes`	array of course registration record types
Return	`boolean`		`true` if `CourseRegistration` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseRegistrationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationFormForCreate
Description	Gets the course registration form for creating new course registrations. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`courseOfferingId`	the Id for a `CourseOffering`
	`osid.id.Id`	`resourceId`	the Id for a `Resource`
	`osid.type.Type[]`	`courseRegistrationRecordTypes`	array of course registration record types
Return	`osid.course.registration.CourseRegistrationForm`		the course registration form
Errors	NOT_FOUND		`courseOfferingId` or `resourceId` is not found
	NULL_ARGUMENT		`courseOfferingId, resourceId` , or `courseRegistrationRecordTypes` 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	createCourseRegistration
Description	Creates a new `CourseRegistration` .
Parameters	`osid.course.registration.CourseRegistrationForm`	`courseRegistrationForm`	the form for this `CourseRegistration`
Return	`osid.course.registration.CourseRegistration`		the new `CourseRegistration`
Errors	ILLEGAL_STATE		`courseRegistrationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`courseRegistrationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseRegistrationForm` did not originate from `getCourseRegistrationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCourseRegistrations
Description	Tests if this user can update `CourseRegistrat` ions. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CourseRegistr` ation will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `CourseRegistration` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationFormForUpdate
Description	Gets the course registration form for updating an existing course registration. A new course registration form should be requested for each update transaction.
Parameters	`osid.id.Id`	`courseRegistrationId`	the `Id` of the `CourseRegistration`
Return	`osid.course.registration.CourseRegistrationForm`		the course registration form
Errors	NOT_FOUND		`courseRegistrationId` is not found
	NULL_ARGUMENT		`courseRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCourseRegistration
Description	Updates an existing course registration.
Parameters	`osid.course.registration.CourseRegistrationForm`	`courseRegistrationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`courseRegistrationForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`courseRegistrationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseRegistrationForm` did not originate from `getCourseRegistrationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCourseRegistrations
Description	Tests if this user can delete `CourseRegistrat` ions. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CourseRegistr` ation will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `CourseRegistration` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCourseRegistration
Description	Deletes a `CourseRegistration` .
Parameters	`osid.id.Id`	`courseRegistrationId`	the `Id` of the `CourseRegistration` to remove
Errors	NOT_FOUND		`courseRegistrationId` not found
	NULL_ARGUMENT		`courseRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCourseRegistrationAliases
Description	Tests if this user can manage `Id` aliases for `CourseRegistra` tions 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 `CourseRegistration` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCourseRegistration
Description	Adds an `Id` to a `CourseRegistr` ation for the purpose of creating compatibility. The primary `Id` of the `CourseRegistr` ation is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another course registration, it is reassigned to the given course registration `Id` .
Parameters	`osid.id.Id`	`courseRegistrationId`	the `Id` of a `CourseRegistration`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`courseRegistrationId` not found
	NULL_ARGUMENT		`courseRegistrationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.