OSID - osid.course.registration.request.RegistrationRequestItemAdminSession Service Interface Definition

Interface	osid.course.registration.request.RegistrationRequestItemAdminSession
Implements	`osid.OsidSession`
Used By	`osid.course.registration.request.RegistrationRequestManager`
Used By	`osid.course.registration.request.RegistrationRequestProxyManager`
Description	This session creates, updates, and deletes `RegistrationReq` uestItems. 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 `RegistrationRe` questItem, a `RegistrationReque` stItemForm is requested using `getRegistrationRequestItemFormForm()` specifying the desired registration request and record `Types` or none if no record `Types` are needed. Each form request method corresponds to an operation of the `RegistrationRequestItem` . The returned `RegistrationReque` stItemForm 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 `RegistrationReque` stItemForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RegistrationReque` stItemForm corresponds to an attempted transaction. For updates, `RegistrationReques` tItemForms are requested to the `RegistrationR` equestItem `Id` that is to be updated using `getRegistrationRequestItemFormFo` rUpdate(). Similarly, the `RegistrationReque` stItemForm has metadata about the data that can be updated and it can perform validation before submitting the update. The `RegistrationReque` stItemForm can only be used once for a successful update and cannot be reused. The delete operations delete `RegistrationReq` uestItems. To unmap a `RegistrationR` equestItem from the current `CourseCatalog` , the `RegistrationRequestItemCourseCatalogAssignm` entSession should be used. These delete operations attempt to remove the `RegistrationR` equestItem 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.CourseCatalogList`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRegistrationRequestItems
Description	Tests if this user can create `RegistrationReq` uestItems. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RegistrationR` equestItem 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 `RegistrationRequestItem` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRegistrationRequestItemWithRecordTypes
Description	Tests if this user can create a single `RegistrationRe` questItem using the desired record types. While `RegistrationRequestManager.getRegistrationRequestItemRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RegistrationRe` questItem. Providing an empty array tests if a `RegistrationReq` uestItem can be created with no records.
Parameters	`osid.type.Type[]`	`registrationRequestItemRecordTypes`	array of registration request item record types
Return	`boolean`		`true` if `RegistrationRequestItem` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationRequestItemRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemFormForCreateForAdd
Description	Gets the registration request item form for creating new ADD registration request items. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`registrationRequestId`	a registration request `Id`
Parameters	`osid.type.Type[]`	`registrationRequestItemRecordTypes`	array of registration request item record types
Return	`osid.course.registration.request.RegistrationRequestItemForm`		the registration request item form
Errors	NOT_FOUND		`registrationRequestId` is not found
	NULL_ARGUMENT		`registrationRequestId` or `registrationRequestItemRecordTypes` 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	getRegistrationRequestItemFormForCreateForUpdate
Description	Gets the registration request item form for creating new UPDATE registration request items. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`registrationRequestId`	a registration request `Id`
Parameters	`osid.type.Type[]`	`registrationRequestItemRecordTypes`	array of registration request item record types
Return	`osid.course.registration.request.RegistrationRequestItemForm`		the registration request item form
Errors	NOT_FOUND		`registrationRequestId` is not found
	NULL_ARGUMENT		`registrationRequestId` or `registrationRequestItemRecordTypes` 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	getRegistrationRequestItemFormForCreateForDrop
Description	Gets the registration request item form for creating new DROP registration request items. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`registrationRequestId`	a registration request `Id`
Parameters	`osid.type.Type[]`	`registrationRequestItemRecordTypes`	array of registration request item record types
Return	`osid.course.registration.request.RegistrationRequestItemForm`		the registration request item form
Errors	NOT_FOUND		`registrationRequestId` is not found
	NULL_ARGUMENT		`registrationRequestId` or `registrationRequestItemRecordTypes` 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	createRegistrationRequestItem
Description	Creates a new `RegistrationRequestItem` .
Parameters	`osid.course.registration.request.RegistrationRequestItemForm`	`registrationRequestItemForm`	the form for this `RegistrationRequestItem`
Return	`osid.course.registration.request.RegistrationRequestItem`		the new `RegistrationRequestItem`
Errors	ILLEGAL_STATE		`registrationRequestItemForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`registrationRequestItemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationRequestItemForm` did not originate from `getRegistrationRequestItemFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRegistrationRequestItems
Description	Tests if this user can update `RegistrationReq` uestItems. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RegistrationR` equestItem 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 `RegistrationRequestItem` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemFormForUpdate
Description	Gets the registration request item form for updating an existing registration request item. A new registration request item form should be requested for each update transaction.
Parameters	`osid.id.Id`	`registrationRequestItemId`	the `Id` of the `RegistrationRequestItem`
Return	`osid.course.registration.request.RegistrationRequestItemForm`		the registration request item form
Errors	NOT_FOUND		`registrationRequestItemId` is not found
	NULL_ARGUMENT		`registrationRequestItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRegistrationRequestItem
Description	Updates an existing registration request item.
Parameters	`osid.course.registration.request.RegistrationRequestItemForm`	`registrationRequestItemForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`registrationRequestItemForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`registrationRequestItemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationRequestItemForm` did not originate from `getRegistrationRequestItemFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRegistrationRequestItems
Description	Tests if this user can delete `RegistrationReq` uestItems. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RegistrationR` equestItem 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 `RegistrationRequestItem` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRegistrationRequestItem
Description	Deletes a `RegistrationRequestItem` .
Parameters	`osid.id.Id`	`registrationRequestItemId`	the `Id` of the `RegistrationRequestItem` to remove
Errors	NOT_FOUND		`registrationRequestItemId` not found
	NULL_ARGUMENT		`registrationRequestItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRegistrationRequestItemAliases
Description	Tests if this user can manage `Id` aliases for `RegistrationRe` questItems 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 `RegistrationRequestItem` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRegistrationRequestItem
Description	Adds an `Id` to a `RegistrationR` equestItem for the purpose of creating compatibility. The primary `Id` of the `RegistrationR` equestItem 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 request item, it is reassigned to the given registration request item `Id` .
Parameters	`osid.id.Id`	`registrationRequestItemId`	the `Id` of a `RegistrationRequestItem`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`registrationRequestItemId` not found
	NULL_ARGUMENT		`registrationRequestItemId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.