Interface | osid.tracking.rules.QueueConstrainerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Queue constrainer may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
Method | getFrontOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the FrontOffice Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOffice | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOffice | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchQueueConstrainers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedFrontOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include queue constrainer in front offices which are children of this queue in the front office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFrontOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this front office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueConstrainerQuery | ||
Description |
Gets a queue constrainer query. | ||
Return | osid.tracking.rules.QueueConstrainerQuery | the queue constrainer query | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.tracking.rules.QueueConstrainerQuery | queueConstrainerQuery | the queue constrainer query |
Return | osid.tracking.rules.QueueConstrainerList | the returned QueueConstrainerList | |
Errors | NULL_ARGUMENT | queueConstrainerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueConstrainerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |