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

This session creates and removes queue processor enablers. The data for create and update is provided via the QueueProcessorEnablerForm.

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.
MethodcanCreateQueueProcessorEnabler
Description

Tests if this user can create queue processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a QueueProcessorEnabler 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 QueueProcessorEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueueProcessorEnablerWithRecordTypes
Description

Tests if this user can create a single QueueProcessorEnabler using the desired record types. While ProvisioningRulesManager.getQueueProcessorEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific QueueProcessorEnabler. Providing an empty array tests if a QueueProcessorEnabler can be created with no records.

Parametersosid.type.Type[]queueProcessorEnablerRecordTypesarray of types
Returnboolean true if QueueProcessorEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT queueProcessorEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerFormForCreate
Description

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

Returnosid.provisioning.rules.QueueProcessorEnablerFormthe queue processor enabler form
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcreateQueueProcessorEnabler
Description

Creates a new QueueProcessorEnabler.

Parametersosid.provisioning.rules.QueueProcessorEnablerFormqueueProcessorEnablerFormthe form for this QueueProcessorEnabler
Returnosid.provisioning.rules.QueueProcessorEnablerthe new QueueProcessorEnabler
ErrorsILLEGAL_STATE queueProcessorEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT queueProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueProcessorEnablerForm did not originate from getQueueProcessorEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateQueueProcessorEnablers
Description

Tests if this user can update queue processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a QueueProcessorEnabler 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 QueueProcessorEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerFormForUpdate
Description

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

Parametersosid.id.IdqueueProcessorEnablerIdthe Id of the QueueProcessorEnabler
Returnosid.provisioning.rules.QueueProcessorEnablerFormthe queue processor enabler form
ErrorsNOT_FOUND queueProcessorEnablerId is not found
NULL_ARGUMENT queueProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateQueueProcessorEnabler
Description

Updates an existing queue processor enabler.

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

Tests if this user can delete queue processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a QueueProcessorEnabler 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 QueueProcessorEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteQueueProcessorEnabler
Description

Deletes a QueueProcessorEnabler.

Parametersosid.id.IdqueueProcessorEnablerIdthe Id of the QueueProcessorEnabler to remove
ErrorsNOT_FOUND queueProcessorEnablerId not found
NULL_ARGUMENT queueProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageQueueProcessorEnablerAliases
Description

Tests if this user can manage Id aliases for queue processor enablers. 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 QueueProcessorEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasQueueProcessorEnabler
Description

Adds a Id to a QueueProcessorEnabler for the purpose of creating compatibility. The primary Id of the QueueProcessorEnabler 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 enabler. it is reassigned to the given queue processor enabler Id.

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