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

This session provides methods to apply QueueConstrainerEnablers to QueueConstrainers. a QueueConstrainer with multiple QueueConstrainerEnablers means any positive rule evaluation across the enablers result in an effective QueueConstrainer.

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

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

Adds an existing QueueConstrainerEnabler to a QueueConstrainer.

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

Removes a QueueConstrainerEnabler from a QueueConstrainer.

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler
osid.id.IdqueueConstrainerIdthe Id of the QueueConstrainer
ErrorsNOT_FOUND queueConstrainerEnablerId or queueConstrainerId not found or queueConstrainerEnablerId not applied to queueConstrainerId
NULL_ARGUMENT queueConstrainerEnablerId or queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceQueueConstrainerEnablers
Description

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

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

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

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

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

Reorders a set of queue constrainer enablers for a queue constrainer.

Parametersosid.id.Id[]queueConstrainerEnablerIdsthe Ids for a set of QueueConstrainerEnablers
osid.id.IdqueueConstrainerIdthe Id of a QueueConstrainer
ErrorsNOT_FOUND queueConstrainerId not found or, a queueConstrainerEnablerId not related to queueConstrainerId
NULL_ARGUMENT queueConstrainerEnablerIds or queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.