Interface | osid.tracking.rules.QueueConstrainerSmartFrontOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic front office. a This | ||
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 | canManageSmartFrontOffices | ||
Description |
Tests if this user can manage smart front office. 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 front office management is not authorized,
true otherwise | |
Compliance | mandatory | This method 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 | getQueueConstrainerSearchOrder | ||
Description |
Gets a queue constrainer search order. | ||
Return | osid.tracking.rules.QueueConstrainerSearchOrder | the queue constrainer search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyQueueConstrainerQuery | ||
Description |
Applies a queue constrainer query to this front office. | ||
Parameters | osid.tracking.rules.QueueConstrainerQuery | queueConstrainerQuery | the queue constrainer query |
Errors | NULL_ARGUMENT | queueConstrainerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | queueConstrainerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectQueueConstrainerQuery | ||
Description |
Gets a queue constrainer query inspector for this front office. | ||
Return | osid.tracking.rules.QueueConstrainerQueryInspector | the queue constrainer query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyQueueConstrainerSequencing | ||
Description |
Applies a queue constrainer search order to this front office. | ||
Parameters | osid.tracking.rules.QueueConstrainerSearchOrder | queueConstrainerSearchOrder | the queue constrainer search order |
Errors | NULL_ARGUMENT | queueConstrainerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | queueConstrainerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerQueryFromInspector | ||
Description |
Gets a queue constrainer query from an inspector. | ||
Parameters | osid.tracking.rules.QueueConstrainerQueryInspector | queueConstrainerQueryInspector | a queue constrainer query inspector |
Return | osid.tracking.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. |