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

Interface	osid.course.registration.ActivityRegistrationAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `ActivityRegistrations.` 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 `ActivityRegistration,` an `ActivityRegistrationForm` is requested using `getRegistrationFormForCreate()` specifying the registration, activity, student, and desired record `Types` or none if no record `Types` are needed. The returned `ActivityRegistrationForm` 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 `ActivityRegistrationForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ActivityRegistrationForm` corresponds to an attempted transaction. For updates, `ActivityRegistrationForms` are requested to the `ActivityRegistrationForm` `Id` that is to be updated using `getActivityRegistrationFormForUpdate().` Similarly, the `ActivityRegistrationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ActivityRegistrationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ActivityRegistrations.` To unmap an `ActivityRegistration` from the current `CourseCatalog,` the `ActivityRegistrationCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `ActivityRegistrationForm` 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	canCreateActivityRegistrations
Description	Tests if this user can create `ActivityRegistrations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `ActivityRegistration` 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 `ActivityRegistration` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateActivityRegistrationWithRecordTypes
Description	Tests if this user can create a single `ActivityRegistration` using the desired record types. While `CourseRegistrationManager.getActivityRegistrationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ActivityRegistration.` Providing an empty array tests if an `ActivityRegistration` can be created with no records.
Parameters	`osid.type.Type[]`	`activityRegistrationRecordTypes`	array of activity registration record types
Return	`boolean`		`true` if `ActivityRegistration` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityRegistrationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationFormForCreate
Description	Gets the course form for creating new activity registrations. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`registrationId`	the `Id` for a `Registration`
	`osid.id.Id`	`activityId`	the `Id` for an `Activity`
	`osid.id.Id`	`resourceId`	the `Id` for a `Resource`
	`osid.type.Type[]`	`activityRegistrationRecordTypes`	array of activity registration record types
Return	`osid.course.registration.ActivityRegistrationForm`		the activity registration form
Errors	NOT_FOUND		`activityId` or `resourceId` is not found
	NULL_ARGUMENT		`activityId, resourceId,` or `activityRegistrationRecordTypes` 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	createActivityRegistration
Description	Creates a new `ActivityRegistration.`
Parameters	`osid.course.registration.ActivityRegistrationForm`	`activityRegistrationForm`	the form for this `ActivityRegistration`
Return	`osid.course.registration.ActivityRegistration`		the new `ActivityRegistration`
Errors	ILLEGAL_STATE		`activityRegistrationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`activityRegistrationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityRegistrationForm` did not originate from `getActivityRegistrationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateActivityRegistrations
Description	Tests if this user can update `ActivityRegistrations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `ActivityRegistration` 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 `ActivityRegistration` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationFormForUpdate
Description	Gets the activity registration form for updating an existing activity registration. A new activity registration form should be requested for each update transaction.
Parameters	`osid.id.Id`	`activityRegistrationId`	the `Id` of the `ActivityRegistration`
Return	`osid.course.registration.ActivityRegistrationForm`		the activity registration form
Errors	NOT_FOUND		`activityRegistrationId` is not found
	NULL_ARGUMENT		`activityRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateActivityRegistration
Description	Updates an existing activity registration.
Parameters	`osid.id.Id`	`activityRegistrationId`	the `Id` of the `ActivityRegistration`
Parameters	`osid.course.registration.ActivityRegistrationForm`	`activityRegistrationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`activityRegistrationForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`activityRegistrationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityRegistrationForm` did not originate from `getActivityRegistrationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteActivityRegistrations
Description	Tests if this user can delete `ActivityRegistrations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `ActivityRegistration` 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 `ActivityRegistration` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteActivityRegistration
Description	Deletes an `ActivityRegistration.`
Parameters	`osid.id.Id`	`activityRegistrationId`	the `Id` of the `ActivityRegistration` to remove
Errors	NOT_FOUND		`activityRegistrationId` not found
	NULL_ARGUMENT		`activityRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageActivityRegistrationAliases
Description	Tests if this user can manage `Id` aliases for `ActivityRegistrations.` 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 `ActivityRegistration` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasActivityRegistration
Description	Adds an `Id` to an `ActivityRegistration` for the purpose of creating compatibility. The primary `Id` of the `ActivityRegistration` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another activity registration, it is reassigned to the given activity registration `Id.`
Parameters	`osid.id.Id`	`activityRegistrationId`	the `Id` of an `ActivityRegistration`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`activityRegistrationId` not found
	NULL_ARGUMENT		`activityRegistrationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.