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

Interface	osid.course.registration.RegistrationAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.registration.batch.RegistrationBatchAdminSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session creates, updates, and deletes `Registrations`. 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 `Registration`, a `RegistrationForm` is requested using `getRegistrationFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RegistrationForm` 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 `RegistrationForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RegistrationForm` corresponds to an attempted transaction. For updates, `RegistrationForms` are requested to the `RegistrationForm` `Id` that is to be updated using `getRegistrationFormForUpdate()`. Similarly, the `RegistrationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RegistrationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Registrations`. To unmap a `Registration` from the current `CourseCatalog`, the `RegistrationCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `RegistrationForm` 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	canCreateRegistrations
Description	Tests if this user can create `Registrations`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Registration` 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 `Registration` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRegistrationWithRecordTypes
Description	Tests if this user can create a single `Registration` using the desired record types. While `CourseRegistrationManager.getRegistrationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Registration`. Providing an empty array tests if a `Registration` can be created with no records.
Parameters	`osid.type.Type[]`	`registrationRecordTypes`	array of registration record types
Return	`boolean`		`true` if `Registration` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationFormForCreate
Description	Gets the registration form for creating new registrations. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`courseRegistrationId`	the `Id` of the course registration
	`osid.id.Id`	`registrationTargetId`	the `Id` of the registration target
	`osid.id.Id`	`resourceId`	the `Id` of the student
	`osid.type.Type[]`	`registrationRecordTypes`	array of registration record types
Return	`osid.course.registration.RegistrationForm`		the registration form
Errors	NOT_FOUND		`courseRegistrationId, registrationTargetId`, or `resourceId` not found
	NULL_ARGUMENT		`courseRegistrationId, registrationTargetId`, `resourceId`, or `registrationRecordTypes` 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	createRegistration
Description	Creates a new `Registration`.
Parameters	`osid.course.registration.RegistrationForm`	`registrationForm`	the form for this `Registration`
Return	`osid.course.registration.Registration`		the new `Registration`
Errors	ILLEGAL_STATE		`registrationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NOT_FOUND		`registrationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationForm` did not originate from `getRegistrationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRegistrations
Description	Tests if this user can update `Registrations`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Registration` 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 `Registration` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationFormForUpdate
Description	Gets the registration form for updating an existing registration. A new registration form should be requested for each update transaction.
Parameters	`osid.id.Id`	`registrationId`	the `Id` of the `Registration`
Return	`osid.course.registration.RegistrationForm`		the registration form
Errors	NOT_FOUND		`registrationId` is not found
	NULL_ARGUMENT		`registrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRegistration
Description	Updates an existing registration.
Parameters	`osid.course.registration.RegistrationForm`	`registrationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`registrationForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`registrationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationForm` did not originate from `getRegistrationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRegistrations
Description	Tests if this user can delete `Registrations`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Registration` 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 `Registration` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRegistration
Description	Deletes a `Registration`.
Parameters	`osid.id.Id`	`registrationId`	the `Id` of the `Registration` to remove
Errors	NOT_FOUND		`registrationId` not found
	NULL_ARGUMENT		`registrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRegistrationAliases
Description	Tests if this user can manage `Id` aliases for `Registrations`. 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 `Registration` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRegistration
Description	Adds an `Id` to a `Registration` for the purpose of creating compatibility. The primary `Id` of the `Course` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another registration, it is reassigned to the given registration `Id`.
Parameters	`osid.id.Id`	`registrationId`	the `Id` of a `Registration`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`registrationId` not found
	NULL_ARGUMENT		`registrationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.