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

This session provides methods to apply QueueConstrainers to Queues. A Queue with multiple QueueConstrainers means any positive rule evaluation across the constrainers result in an accessible Queue.

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

Tests if this user can alter queue constrainer/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.
MethodassignQueueConstrainerToQueue
Description

Adds an existing QueueConstrainer to a Queue.

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

Removes a QueueConstrainer from a Queue.

Parametersosid.id.IdqueueConstrainerIdthe Id of the QueueConstrainer
osid.id.IdqueueIdthe Id of the Queue
ErrorsNOT_FOUND queueConstrainerId or queueId not found or queueConstrainerId not applied to queueId
NULL_ARGUMENT queueConstrainerId or queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceQueueConstrainers
Description

Tests if this user can order QueueConstrainers. 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 QueueConstrainer ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveQueueConstrainerAhead
Description

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

Parametersosid.id.IdqueueConstrainerIdthe Id of a QueueConstrainer
osid.id.IdqueueIdthe Id of a Queue
osid.id.IdreferenceIdthe reference queue constrainer Id
ErrorsNOT_FOUND queueConstrainerId, queueId, or referenceId not found or, queueConstrainerId or referenceId not related to queueId
NULL_ARGUMENT queueConstrainerId, queueId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveQueueConstrainerBehind
Description

Reorders queue constrainer for a queue by moving the specified queue constrainer behind a reference queue constrainer.

Parametersosid.id.IdqueueConstrainerIdthe Id of a QueueConstrainer
osid.id.IdqueueIdthe Id of a Queue
osid.id.IdreferenceIdthe reference queue constrainer Id
ErrorsNOT_FOUND queueConstrainerId, queueId, or referenceId not found or, queueConstrainerId or referenceId not related to queueId
NULL_ARGUMENT queueConstrainerId, queueId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderQueueConstrainers
Description

Reorders a set of queue constrainers for a queue.

Parametersosid.id.Id[]queueConstrainerIdsthe Ids for a set of QueueConstrainers
osid.id.IdqueueIdthe Id of a QueueConstrainer
ErrorsNOT_FOUND queueId not found or, a queueConstrainerId not related to queueId
NULL_ARGUMENT queueConstrainerIds or queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.