OSID - osid.provisioning.RequestAdminSession Service Interface Definition

Interface	osid.provisioning.RequestAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Requests.` 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. Once a `Request` is created, it has not been submitted. `submitRequest` submits a `Request` for processing. Constraints on update and delete may vary between creation and submission. Create and update operations differ in their usage. To create a `Request,` a `RequestForm` is requested using `getRequestFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RequestForm` 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 `RequestForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RequestForm` corresponds to an attempted transaction. For updates, `RequestForms` are requested to the `Request` `Id` that is to be updated using `getRequestFormForUpdate().` Similarly, the `RequestForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RequestForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Requests.` To unmap a `Request` from the current `Distributor,` the `RequestDistributorAssignmentSession` should be used. These delete operations attempt to remove the `Request` itself thus removing it from all known `Distributor` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRequests
Description	Tests if this user can create `Requests.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Request` 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 `Request` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRequestWithRecordTypes
Description	Tests if this user can create a single `Request` using the desired record types. While `ProvisioningManager.getRequestRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Request.` Providing an empty array tests if a `Request` can be created with no records.
Parameters	`osid.type.Type[]`	`requestRecordTypes`	array of request record types
Return	`boolean`		`true` if `Request` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`requestRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRequestFormForCreate
Description	Gets the request form for creating new requests. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`resourceId`	the `Id` for the resource
	`osid.id.Id`	`queueId`	the `Id` for the queue
	`osid.type.Type[]`	`requestRecordTypes`	array of request record types
Return	`osid.provisioning.RequestForm`		the request form
Errors	NOT_FOUND		`resourceId` or `queueId` is not found
	NULL_ARGUMENT		`resourceId, queueId,` or `requestRecordTypes` 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	createRequest
Description	Creates a new `Request.`
Parameters	`osid.provisioning.RequestForm`	`requestForm`	the form for this `Request`
Return	`osid.provisioning.Request`		the new `Request`
Errors	ILLEGAL_STATE		`requestForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`requestForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`requestForm` did not originate from `getRequestFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRequests
Description	Tests if this user can update `Requests.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Request` 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 `Request` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestFormForUpdate
Description	Gets the request form for updating an existing request. A new request form should be requested for each update transaction.
Parameters	`osid.id.Id`	`requestId`	the `Id` of the `Request`
Return	`osid.provisioning.RequestForm`		the request form
Errors	NOT_FOUND		`requestId` is not found
	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRequest
Description	Updates an existing request.
Parameters	`osid.provisioning.RequestForm`	`requestForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`requestForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`requestForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`requestForm` did not originate from `getRequestFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	submitRequest
Description	Submits a `Request.`
Parameters	`osid.id.Id`	`requestId`	the `Id` of the `Request` to submit
Errors	NOT_FOUND		`requestId` not found
	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCancelRequests
Description	Tests if this user can cancel `Requests.` A return of true does not guarantee successful authorization. A return of false indicates that it is known canceling a `Request` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer cancel operations to an unauthorized user.
Return	`boolean`		`false` if `Request` cancelation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	cancelRequest
Description	Cancels a `Request.`
Parameters	`osid.id.Id`	`requestId`	the `Id` of the `Request` to remove
Errors	NOT_FOUND		`requestId` not found
	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRequests
Description	Tests if this user can delete `Requests.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Request` 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 `Request` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRequest
Description	Deletes a `Request.`
Parameters	`osid.id.Id`	`requestId`	the `Id` of the `Request` to remove
Errors	NOT_FOUND		`requestId` not found
	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRequestAliases
Description	Tests if this user can manage `Id` aliases for `Requests.` 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 `Request` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRequest
Description	Adds an `Id` to a `Request` for the purpose of creating compatibility. The primary `Id` of the `Request` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another request, it is reassigned to the given request `Id.`
Parameters	`osid.id.Id`	`requestId`	the `Id` of a `Request`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`requestId` not found
	NULL_ARGUMENT		`requestId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.