Interface | osid.tracking.QueueSmartFrontOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. 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 front 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 frontOffices. 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 | getQueueQuery | ||
Description |
Gets a queue query. | ||
Return | osid.tracking.QueueQuery | the queue query | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueSearchOrder | ||
Description |
Gets a queue search order. | ||
Return | osid.tracking.QueueSearchOrder | the queue search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyQueueQuery | ||
Description |
Applies a queue query to this front office. | ||
Parameters | osid.tracking.QueueQuery | queueQuery | the queue query |
Errors | NULL_ARGUMENT | queueQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | queueQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectQueueQuery | ||
Description |
Gets a queue query inspector for this front office. | ||
Return | osid.tracking.QueueQueryInspector | the queue query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyQueueSequencing | ||
Description |
Applies a queue search order to this front office. | ||
Parameters | osid.tracking.QueueSearchOrder | queueSearchOrder | the queue search order |
Errors | NULL_ARGUMENT | queueSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | queueSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueQueryFromInspector | ||
Description |
Gets a queue query from an inspector. | ||
Parameters | osid.tracking.QueueQueryInspector | queueQueryInspector | a queue query inspector |
Return | osid.tracking.QueueQuery | the queue query | |
Errors | NULL_ARGUMENT | queueQueryInspector is null | |
UNSUPPORTED | queueQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |