OSID - osid.provisioning.ExchangeSession Service Interface Definition

Interface	osid.provisioning.ExchangeSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session exchanges an existing provision for a request for another provision via the queue. The data for create and update is provided via the `RequestForm` .
Method	getQueueId
Description	Gets the `Queue` `Id` associated with this session.
Return	`osid.id.Id`		the `Queue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getQueue
Description	Gets the `Queue` associated with this session.
Return	`osid.provisioning.Queue`		the queue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRequestsInExchange
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.
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the provision to exchange
Return	`boolean`		`false` if `Request` creation is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`provisionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRequestWithRecordTypesInExchange
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.id.Id`	`provisionId`	the `Id` of the provision to exchange
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		`provisionId` or `requestRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRequestFormForCreate
Description	Gets the request form for creating new requests for the exchange. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the provision to exchange
Parameters	`osid.type.Type[]`	`requestRecordTypes`	array of request record types
Return	`osid.provisioning.RequestForm`		the request form
Errors	NOT_FOUND		`provisionId` is not found
	NULL_ARGUMENT		`provisionId` 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	createRequestInExchange
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.