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

This session provides methods to apply QueueProcessors to Queues.

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

Tests if this user can alter queue processor/queue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignQueueProcessorToQueue
Description

Adds an existing QueueProcessor to a Queue.

Parametersosid.id.IdqueueProcessorIdthe Id of the QueueProcessor
osid.id.IdqueueIdthe Id of the Queue
ErrorsALREADY_EXISTS queueProcessorId is already applied to queueId
NOT_FOUND queueProcessorId or queueId not found
NULL_ARGUMENT queueProcessorId or queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignQueueProcessorFromQueue
Description

Removes a QueueProcessor from a Queue.

Parametersosid.id.IdqueueProcessorIdthe Id of the QueueProcessor
osid.id.IdqueueIdthe Id of the Queue
ErrorsNOT_FOUND queueProcessorId or queueId not found or queueProcessorId not applied to queueId
NULL_ARGUMENT queueProcessorId or queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceQueueProcessors
Description

Tests if this user can order QueueProcessors. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

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

Reorders queue processors for a queue by moving the specified queue processor in front of a reference queue processor.

Parametersosid.id.IdqueueProcessorIdthe Id of a QueueProcessor
osid.id.IdqueueIdthe Id of a Queue
osid.id.IdreferenceIdthe reference queue processor Id
ErrorsNOT_FOUND queueProcessorId, queueId, or referenceId not found or, queueProcessorId or referenceId not related to queueId
NULL_ARGUMENT queueProcessorId, queueId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveQueueProcessorBehind
Description

Reorders queue processors for a queue by moving the specified queue processor behind a reference queue processor.

Parametersosid.id.IdqueueProcessorIdthe Id of a QueueProcessor
osid.id.IdqueueIdthe Id of a Queue
osid.id.IdreferenceIdthe reference queue processor Id
ErrorsNOT_FOUND queueProcessorId, queueId, or referenceId not found or, queueProcessorId or referenceId not related to queueId
NULL_ARGUMENT queueProcessorId, queueId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderQueueProcessors
Description

Reorders a set of queue processors for a queue.

Parametersosid.id.Id[]queueProcessorIdsthe Ids for a set of QueueProcessors
osid.id.IdqueueIdthe Id of a QueueProcessor
ErrorsNOT_FOUND queueId not found or, a queueProcessorId not related to queueId
NULL_ARGUMENT queueProcessorIds or queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.