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

Interface	osid.course.registration.request.RegistrationRequestAdminSession
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` uests. 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` quest, a `RegistrationReque` stForm is requested using `getRegistrationRequestFormForCr` eate() specifying the desired term and record `Types` or none if no record `Types` are needed. The returned `RegistrationReque` stForm 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` stForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RegistrationReque` stForm corresponds to an attempted transaction. For updates, `RegistrationReques` tForms are requested to the `RegistrationR` equest `Id` that is to be updated using `getRegistrationRequestFormForUpd` ate(). Similarly, the `RegistrationReque` stForm has metadata about the data that can be updated and it can perform validation before submitting the update. The `RegistrationReque` stForm can only be used once for a successful update and cannot be reused. The delete operations delete `RegistrationReq` uests. To unmap a `RegistrationR` equest from the current `CourseCatalog` , the `RegistrationRequestCourseCatalogAssignmentS` ession should be used. These delete operations attempt to remove the `RegistrationR` equest 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` . `OsidRequests` include a submit operation for processing. `submitRegistrationRequest()` is used after the complete request has been created and may only be submitted once.
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	canCreateRegistrationRequests
Description	Tests if this user can create `RegistrationReq` uests. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RegistrationR` equest 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 `RegistrationRequest` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRegistrationRequestWithRecordTypes
Description	Tests if this user can create a single `RegistrationRe` quest using the desired record types. While `RegistrationRequestManager.getRegistrationRequestRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RegistrationRe` quest. Providing an empty array tests if a `RegistrationReq` uest can be created with no records.
Parameters	`osid.type.Type[]`	`registrationRequestRecordTypes`	array of registration request record types
Return	`boolean`		`true` if `RegistrationRequest` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`registrationRequestRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestFormForCreate
Description	Gets the registration request form for creating new registration requests. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Parameters	`osid.type.Type[]`	`registrationRequestRecordTypes`	array of registration request record types
Return	`osid.course.registration.request.RegistrationRequestForm`		the registration request form
Errors	NOT_FOUND		`termId` is not found
	NULL_ARGUMENT		`termId` or `registrationRequestRecordTypes` 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	createRegistrationRequest
Description	Creates a new `RegistrationRequest` .
Parameters	`osid.course.registration.request.RegistrationRequestForm`	`registrationRequestForm`	the form for this `RegistrationRequest`
Return	`osid.course.registration.request.RegistrationRequest`		the new `RegistrationRequest`
Errors	ILLEGAL_STATE		`registrationRequestForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`registrationRequestForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationRequestForm` did not originate from `getRegistrationRequestFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRegistrationRequests
Description	Tests if this user can update `RegistrationReq` uests. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RegistrationR` equest 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 `RegistrationRequest` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestFormForUpdate
Description	Gets the registration request form for updating an existing registration request. A new registration request form should be requested for each update transaction.
Parameters	`osid.id.Id`	`registrationRequestId`	the `Id` of the `RegistrationRequest`
Return	`osid.course.registration.request.RegistrationRequestForm`		the registration request form
Errors	NOT_FOUND		`registrationRequestId` is not found
	NULL_ARGUMENT		`registrationRequestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRegistrationRequest
Description	Updates an existing registration request.
Parameters	`osid.course.registration.request.RegistrationRequestForm`	`registrationRequestForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`registrationRequestForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`registrationRequestForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationRequestForm` did not originate from `getRegistrationRequestFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRegistrationRequests
Description	Tests if this user can delete `RegistrationReq` uests. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RegistrationR` equest 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 `RegistrationRequest` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRegistrationRequest
Description	Deletes a `RegistrationRequest` .
Parameters	`osid.id.Id`	`registrationRequestId`	the `Id` of the `RegistrationRequest` to remove
Errors	NOT_FOUND		`registrationRequestId` not found
	NULL_ARGUMENT		`registrationRequestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRegistrationRequestAliases
Description	Tests if this user can manage `Id` aliases for `RegistrationRe` quests 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 `RegistrationRequest` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRegistrationRequest
Description	Adds an `Id` to a `RegistrationR` equest for the purpose of creating compatibility. The primary `Id` of the `RegistrationR` equest 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, it is reassigned to the given registration request `Id` .
Parameters	`osid.id.Id`	`registrationRequestId`	the `Id` of a `RegistrationRequest`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`registrationRequestId` not found
	NULL_ARGUMENT		`registrationRequestId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	submitRegistrationRequest
Description	Submits a registration request for porcessing. A `RegistrationRequest` can only be submitted once.
Parameters	`osid.id.Id`	`registrationRequestId`	the `Id` of a `RegistrationRequest`
Errors	ILLEGAL_STATE		`registrationRequestId` already submitted
	NOT_FOUND		`registrationRequestId` not found
	NULL_ARGUMENT		`registrationRequestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.