OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueProcessorAdminSession
Implementsosid.OsidSession
Description

This session creates and removes queue processors. The data for create and update is provided via the QueueProcessorForm.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueueProcessor
Description

Tests if this user can create queue processors. 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. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if QueueProcessor creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueueProcessorWithRecordTypes
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 created with no records.

Parametersosid.type.Type[]queueProcessorRecordTypesarray of queue processor record types
Returnboolean true if QueueProcessor creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT queueProcessorRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorFormForCreate
Description

Gets the queue processor form for creating new queue processors. A new form should be requested for each create transaction.

Parametersosid.type.Type[]queueProcessorRecordTypesarray of queue processor record types
Returnosid.provisioning.rules.QueueProcessorFormthe queue processor form
ErrorsNULL_ARGUMENT queueProcessorRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateQueueProcessor
Description

Creates a new QueueProcessor.

Parametersosid.provisioning.rules.QueueProcessorFormqueueProcessorFormthe form for this QueueProcessor
Returnosid.provisioning.rules.QueueProcessorthe new QueueProcessor
ErrorsILLEGAL_STATE queueProcessorForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT queueProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueProcessorForm did not originate from getQueueProcessorFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateQueueProcessors
Description

Tests if this user can update queue processors. 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. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if QueueProcessor modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorFormForUpdate
Description

Gets the queue processor form for updating an existing queue processor. A new queue processor form should be requested for each update transaction.

Parametersosid.id.IdqueueProcessorIdthe Id of the QueueProcessor
Returnosid.provisioning.rules.QueueProcessorFormthe queue processor form
ErrorsNOT_FOUND queueProcessorId is not found
NULL_ARGUMENT queueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateQueueProcessor
Description

Updates an existing queue processor.

Parametersosid.provisioning.rules.QueueProcessorFormqueueProcessorFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE queueProcessorForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT queueProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueProcessorForm did not originate from getQueueProcessorFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteQueueProcessors
Description

Tests if this user can delete queue processors. 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. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if QueueProcessor deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteQueueProcessor
Description

Deletes a QueueProcessor.

Parametersosid.id.IdqueueProcessorIdthe Id of the QueueProcessor to remove
ErrorsNOT_FOUND queueProcessorId not found
NULL_ARGUMENT queueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageQueueProcessorAliases
Description

Tests if this user can manage Id aliases for queue processors. 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.

Returnboolean false if QueueProcessor aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasQueueProcessor
Description

Adds a 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.

Parametersosid.id.IdqueueProcessorIdthe Id of a QueueProcessor
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND queueProcessorId not found
NULL_ARGUMENT queueProcessorId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.