Interface | osid.provisioning.rules.QueueConstrainerEnablerSmartDistributorSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic distributors. a This | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartDistributors | ||
Description |
Tests if this user can manage smart distributors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart distributor management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablerQuery | ||
Description |
Gets a queue constrainer enabler query. | ||
Return | osid.provisioning.rules.QueueConstrainerEnablerQuery | the queue constrainer enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablerSearchOrder | ||
Description |
Gets a queue constrainer enabler search order. | ||
Return | osid.provisioning.rules.QueueConstrainerEnablerSearchOrder | the queue constrainer enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyQueueConstrainerEnablerQuery | ||
Description |
Applies a queue constrainer enabler query to this distributor. | ||
Parameters | osid.provisioning.rules.QueueConstrainerEnablerQuery | queueConstrainerEnablerQuery | the queue constrainer enabler query |
Errors | NULL_ARGUMENT | queueConstrainerEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | queueConstrainerEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectQueueConstrainerEnablerQuery | ||
Description |
Gets a queue constrainer enabler query inspector for this distributor. | ||
Return | osid.provisioning.rules.QueueConstrainerEnablerQueryInspector | the queue constrainer enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyQueueConstrainerEnablerSequencing | ||
Description |
Applies a queue constrainer enabler search order to this distributor. | ||
Parameters | osid.provisioning.rules.QueueConstrainerEnablerSearchOrder | queueConstrainerEnablerSearchOrder | the queue constrainer enabler search order |
Errors | NULL_ARGUMENT | queueConstrainerEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | queueConstrainerEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablerQueryFromInspector | ||
Description |
Gets a queue constrainer enabler query from an inspector. | ||
Parameters | osid.provisioning.rules.QueueConstrainerEnablerQueryInspector | queueConstrainerEnablerQueryInspector | a queue constrainer enabler query inspector |
Return | osid.provisioning.rules.QueueConstrainerEnablerQuery | the queue constrainer enabler query | |
Errors | NULL_ARGUMENT | queueConstrainerEnablerQueryInspector is null | |
UNSUPPORTED | queueConstrainerEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |