OSID - osid.provisioning.RequestTransactionAdminSession Service Interface Definition

Interface	osid.provisioning.RequestTransactionAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `RequestTransactions.` 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. `submitRequestTransaction` submits a `RequesTransactiont` for processing. Constraints on update and delete may vary between creation and submission. Create and update operations differ in their usage. To create a `RequestTransaction,` a `RequestTransactionForm` is requested using `getRequestTransactionFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RequestTransactionForm` 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 `RequestTransactionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RequestTransactionForm` corresponds to an attempted transaction. For updates, `RequestTransactionForms` are requested to the `RequestTransaction` `Id` that is to be updated using `getRequestTransactionFormForUpdate().` Similarly, the `RequestTransactionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RequestTransactionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `RequestTransactions.` To unmap a `RequestTransaction` from the current `Distributor,` the `RequestTransactionDistributorAssignmentSession` should be used. These delete operations attempt to remove the `ReqeustTransaction` 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	canCreateRequestTransactions
Description	Tests if this user can create `RequestTransactions.` 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 transaction operations to an unauthorized user.
Return	`boolean`		`false` if `RequestTransaction` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRequestTransactionsWithRecordTypes
Description	Tests if this user can create a single `RequestTransaction` using the desired record types. While `ProvisioningManager.getRequestTransactionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RequestTransaction.` Providing an empty array tests if a `RequestTransaction` can be created with no records.
Parameters	`osid.type.Type[]`	`requestTransactionRecordTypes`	array of request transaction record types
Return	`boolean`		`true` if `RequestTransaction` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`requestTransactionRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionFormForCreate
Description	Gets the request transaction form for creating new request transactionss. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type[]`	`requestTransactionRecordTypes`	array of request transaction record types
Return	`osid.provisioning.RequestTransactionForm`		the request transaction form
Errors	NOT_FOUND		`brokerId` or `resourceId` is not found
	NULL_ARGUMENT		`brokerId, resourceId,` or `requestTransactionRecordTypes` 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	createRequestTransaction
Description	Creates a new `RequestTransaction.`
Parameters	`osid.provisioning.RequestTransactionForm`	`requestTransactionForm`	the form for this `RequestTransaction`
Return	`osid.provisioning.RequestTransaction`		the new `RequestTransaction`
Errors	ILLEGAL_STATE		`requestTransactionForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`requestTransactionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`requestForm` did not originate from `getRequestTransactionFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRequestTransactions
Description	Tests if this user can update `RequestTransactions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RequestTransaction` 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 `RequestTransaction` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionFormForUpdate
Description	Gets the request transaction form for updating an existing request. A new request transaction form should be requested for each update transaction.
Parameters	`osid.id.Id`	`requestTransactionId`	the `Id` of the `RequestTransaction`
Return	`osid.provisioning.RequestTransactionForm`		the request transaction form
Errors	NOT_FOUND		`requestTransactionId` is not found
	NULL_ARGUMENT		`requestTransactionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRequestTransaction
Description	Updates an existing request transaction.
Parameters	`osid.provisioning.RequestTransactionForm`	`requestTransactionForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`requestTransactionForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`requestTransactionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`requestForm` did not originate from `getRequestTransactionFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	submitRequestTransaction
Description	Submits a `RequestTransaction` and the related requests.
Parameters	`osid.id.Id`	`requestTransactionId`	the `Id` of the request transaction to submit
Errors	NOT_FOUND		`requestTransactionId` is not found
	NULL_ARGUMENT		`requestTransactionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCancelRequestTransactions
Description	Tests if this user can cancel `RequestTransactions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known canceling a `RequestTransaction` 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 `RequestTransaction` cancelation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	cancelRequestTransaction
Description	Cancels a `RequestTransaction` and the related requests.
Parameters	`osid.id.Id`	`requestTransactionId`	the `Id` of the request transaction to cancel
Errors	NOT_FOUND		`requestTransactionId` is not found
	NULL_ARGUMENT		`requestTransactionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRequestTransactions
Description	Tests if this user can delete `RequestTransactions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RequestTransaction` 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 `RequestTransaction` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRequestTransaction
Description	Deletes a `RequestTransaction` and the related requests.
Parameters	`osid.id.Id`	`requestTransactionId`	the `Id` of the request transaction to delete
Errors	NOT_FOUND		`requestTransactionId` is not found
	NULL_ARGUMENT		`requestTransactionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRequestTransactionAliases
Description	Tests if this user can manage `Id` aliases for `RequestTransactionss.` 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 `RequestTransaction` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRequestTransaction
Description	Adds an `Id` to a `RequestTransaction` for the purpose of creating compatibility. The primary `Id` of the `RequestTransaction` 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`	`requestTransactionId`	the `Id` of a `RequestTransaction`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`requestTransactionId` not found
	NULL_ARGUMENT		`requestTransactionId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.