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

Interface	osid.course.registration.RegistrationTargetAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.registration.batch.RegistrationTargetBatchAdminSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session creates, updates, and deletes `RegistrationTar` gets. 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 `RegistrationTa` rget, a `RegistrationTarge` tForm is requested using `getRegistrationTargetFormForCre` ate() specifying the desired course offering and record `Types` or none if no record `Types` are needed. The returned `RegistrationTarge` tForm 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 `RegistrationTarge` tForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RegistrationTarge` tForm corresponds to an attempted transaction. For updates, `RegistrationTarget` Forms are requested to the `RegistrationT` arget `Id` that is to be updated using `getRegistrationTargetFormForUpda` te(). Similarly, the `RegistrationTarge` tForm has metadata about the data that can be updated and it can perform validation before submitting the update. The `RegistrationTarge` tForm can only be used once for a successful update and cannot be reused. The delete operations delete `RegistrationTar` gets. To unmap a `RegistrationT` arget from the current `CourseCatalog` , the `RegistrationTargetCourseCatalogAssignmentSe` ssion should be used. These delete operations attempt to remove the `RegistrationT` arget 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	canCreateRegistrationTargets
Description	Tests if this user can create `RegistrationTar` gets. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RegistrationT` arget 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 `RegistrationTarget` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRegistrationTargetWithRecordTypes
Description	Tests if this user can create a single `RegistrationTa` rget using the desired record types. While `CourseRegistrationManager.getRegistrationTargetRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RegistrationTa` rget. Providing an empty array tests if a `RegistrationTar` get can be created with no records.
Parameters	`osid.type.Type[]`	`registrationTargetRecordTypes`	array of registration target record types
Return	`boolean`		`true` if `RegistrationTarget` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationTargetRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetFormForCreate
Description	Gets the registration target form for creating new registration targets. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Parameters	`osid.type.Type[]`	`registrationTargetRecordTypes`	array of registration target record types
Return	`osid.course.registration.RegistrationTargetForm`		the registration target form
Errors	NOT_FOUND		`courseOfferingId` is not found
	NULL_ARGUMENT		`courseOfferingId` or `registrationTargetRecordTypes` 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	createRegistrationTarget
Description	Creates a new `RegistrationTarget` .
Parameters	`osid.course.registration.RegistrationTargetForm`	`registrationTargetForm`	the form for this `RegistrationTarget`
Return	`osid.course.registration.RegistrationTarget`		the new `RegistrationTarget`
Errors	ILLEGAL_STATE		`registrationTargetForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`registrationTargetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationTargetForm` did not originate from `getRegistrationTargetFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRegistrationTargets
Description	Tests if this user can update `RegistrationTar` gets. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RegistrationT` arget 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 `RegistrationTarget` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetFormForUpdate
Description	Gets the registration target form for updating an existing registration target. A new registration target form should be requested for each update transaction.
Parameters	`osid.id.Id`	`registrationTargetId`	the `Id` of the `RegistrationTarget`
Return	`osid.course.registration.RegistrationTargetForm`		the registration target form
Errors	NOT_FOUND		`registrationTargetId` is not found
	NULL_ARGUMENT		`registrationTargetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRegistrationTarget
Description	Updates an existing registration target.
Parameters	`osid.course.registration.RegistrationTargetForm`	`registrationTargetForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`registrationTargetForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`registrationTargetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationTargetForm` did not originate from `getRegistrationTargetFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRegistrationTargets
Description	Tests if this user can delete `RegistrationTar` gets. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RegistrationT` arget 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 `RegistrationTarget` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRegistrationTarget
Description	Deletes a `RegistrationTarget` .
Parameters	`osid.id.Id`	`registrationTargetId`	the `Id` of the `RegistrationTarget` to remove
Errors	NOT_FOUND		`registrationTargetId` not found
	NULL_ARGUMENT		`registrationTargetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRegistrationTargetAliases
Description	Tests if this user can manage `Id` aliases for `RegistrationTa` rgets 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 `RegistrationTarget` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRegistrationTarget
Description	Adds an `Id` to a `RegistrationT` arget for the purpose of creating compatibility. The primary `Id` of the `RegistrationT` arget 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 target, it is reassigned to the given registration target `Id` .
Parameters	`osid.id.Id`	`registrationTargetId`	the `Id` of a `RegistrationTarget`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`registrationTargetId` not found
	NULL_ARGUMENT		`registrationTargetId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.