Interface | osid.provisioning.rules.QueueConstrainerSearchSession | ||
---|---|---|---|
Implements | osid.provisioning.rules.QueueConstrainerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getQueueConstrainerSearch | ||
Description |
Gets a queue constrainer search. | ||
Return | osid.provisioning.rules.QueueConstrainerSearch | the queue constrainer search | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerSearchOrder | ||
Description |
Gets a queue constrainer search order. The | ||
Return | osid.provisioning.rules.QueueConstrainerSearchOrder | the queue constrainer search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.provisioning.rules.QueueConstrainerQuery | queueConstrainerQuery | the queue constrainer query |
osid.provisioning.rules.QueueConstrainerSearch | queueConstrainerSearch | the queue constrainer search | |
Return | osid.provisioning.rules.QueueConstrainerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | queueConstrainerQuery or queueConstrainerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueConstrainerQuery or queueConstrainerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerQueryFromInspector | ||
Description |
Gets a queue constrainer query from an inspector. The
inspector is available from a | ||
Parameters | osid.provisioning.rules.QueueConstrainerQueryInspector | queueConstrainerQueryInspector | a queue constrainer query inspector |
Return | osid.provisioning.rules.QueueConstrainerQuery | the queue constrainer query | |
Errors | NULL_ARGUMENT | queueConstrainerQueryInspector is null | |
UNSUPPORTED | queueConstrainerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |