OSID - osid.provisioning.rules.QueueProcessorAdminSession Service Interface Definition

Interface	osid.provisioning.rules.QueueProcessorAdminSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session creates, updates, and deletes `QueueProcessors` . 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 `QueueProcessor` , a `QueueProcessorForm` is requested using `getQueueProcessorFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `QueueProcessorForm` 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 `QueueProcessorForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `QueueProcessorForm` corresponds to an attempted transaction. For updates, `QueueProcessorForms` are requested to the `QueueProcessor` `Id` that is to be updated using `getQueueProcessorFormForUpdate()` . Similarly, the `QueueProcessorForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `QueueProcessorForm` can only be used once for a successful update and cannot be reused. The delete operations delete `QueueProcessors` . To unmap a `QueueProcessor` from the current `Distributor` , the `QueueProcessorDistributorAssignmentSession` should be used. These delete operations attempt to remove the `QueueProcessor` 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	canCreateQueueProcessors
Description	Tests if this user can create `QueueProcessors` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `QueueProcessor` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `QueueProcessor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateQueueProcessorWithRecordTypes
Description	Tests if this user can create a single `QueueProcessor` using the desired record types. While `ProvisioningRulesManager.getQueueProcessorRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `QueueProcessor` . Providing an empty array tests if a `QueueProcessor can be cr` eated with no records.
Parameters	`osid.type.Type[]`	`queueProcessorRecordTypes`	array of queue processor record types
Return	`boolean`		`true` if `QueueProcessor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`queueProcessorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorFormForCreate
Description	Gets the queue processor form for creating new queue processors. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`queueProcessorRecordTypes`	array of queue processor record types
Return	`osid.provisioning.rules.QueueProcessorForm`		the queue processor form
Errors	NULL_ARGUMENT		`queueProcessorRecordTypes` 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	createQueueProcessor
Description	Creates a new `QueueProcessor` .
Parameters	`osid.provisioning.rules.QueueProcessorForm`	`queueProcessorForm`	the form for this `QueueProcessor`
Return	`osid.provisioning.rules.QueueProcessor`		the new `QueueProcessor`
Errors	ILLEGAL_STATE		`queueProcessorForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`queueProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueProcessorForm` did not originate from `getQueueProcessorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateQueueProcessors
Description	Tests if this user can update `QueueProcessors` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `QueueProcessor` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `QueueProcessor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorFormForUpdate
Description	Gets the queue processor form for updating an existing queue processor. A new queue processor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
Return	`osid.provisioning.rules.QueueProcessorForm`		the queue processor form
Errors	NOT_FOUND		`queueProcessorId` is not found
	NULL_ARGUMENT		`queueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateQueueProcessor
Description	Updates an existing queue processor.
Parameters	`osid.provisioning.rules.QueueProcessorForm`	`queueProcessorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`queueProcessorForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`queueProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueProcessorForm` did not originate from `getQueueProcessorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteQueueProcessors
Description	Tests if this user can delete `QueueProcessors` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `QueueProcessor` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `QueueProcessor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteQueueProcessor
Description	Deletes a `QueueProcessor` .
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor` to remove
Errors	NOT_FOUND		`queueProcessorId` not found
	NULL_ARGUMENT		`queueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageQueueProcessorAliases
Description	Tests if this user can manage `Id` aliases for `QueueProcessors` 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 `QueueProcessor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasQueueProcessor
Description	Adds an `Id` to a `QueueProcessor` for the purpose of creating compatibility. The primary `Id` of the `QueueProcessor` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another queue processor, it is reassigned to the given queue processor `Id` .
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of a `QueueProcessor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`queueProcessorId` not found
	NULL_ARGUMENT		`queueProcessorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.