Interface | osid.tracking.rules.QueueProcessorEnablerLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupQueueProcessorEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeQueueProcessorEnablerView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryQueueProcessorEnablerView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedFrontOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include queue processor enablers in front offices which are children of this front office 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 | useActiveQueueProcessorEnablerView | ||
Description |
Only active queue processor enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusQueueProcessorEnablerView | ||
Description |
All active and inactive queue processor enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueProcessorEnabler | ||
Description |
Gets the In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Parameters | osid.id.Id | queueProcessorEnablerId | Id of the QueueProcessorEnabler |
Return | osid.tracking.rules.QueueProcessorEnabler | the queue processor enabler | |
Errors | NOT_FOUND | queueProcessorEnablerId not found | |
NULL_ARGUMENT | queueProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueProcessorEnablersByIds | ||
Description |
Gets a In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Parameters | osid.id.IdList | queueProcessorEnablerIds | the list of Ids to retrieve |
Return | osid.tracking.rules.QueueProcessorEnablerList | the returned QueueProcessorEnabler list | |
Errors | NOT_FOUND | a Id was not found | |
NULL_ARGUMENT | queueProcessorEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablersByGenusType | ||
Description |
Gets a In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Parameters | osid.type.Type | queueProcessorEnablerGenusType | a queue processor enabler genus type |
Return | osid.tracking.rules.QueueProcessorEnablerList | the returned QueueProcessorEnabler list | |
Errors | NULL_ARGUMENT | queueProcessorEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablersByParentGenusType | ||
Description |
Gets a In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Parameters | osid.type.Type | queueProcessorEnablerGenusType | a queue processor enabler genus type |
Return | osid.tracking.rules.QueueProcessorEnablerList | the returned QueueProcessorEnabler list | |
Errors | NULL_ARGUMENT | queueProcessorEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablersByRecordType | ||
Description |
Gets a In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Parameters | osid.type.Type | queueProcessorEnablerRecordType | a queue processor enabler record type |
Return | osid.tracking.rules.QueueProcessorEnablerList | the returned QueueProcessorEnabler list | |
Errors | NULL_ARGUMENT | queueProcessorEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablersOnDate | ||
Description |
Gets a In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.tracking.rules.QueueProcessorEnablerList | the returned QueueProcessorEnabler list | |
Errors | INVALID_ARGUMENT | from is greater tha to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablersOnDateWithAgent | ||
Description |
Gets a In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Parameters | osid.id.Id | agentId | an agent Id |
osid.calendaring.DateTime | from | a start date | |
osid.calendaring.DateTime | to | an end date | |
Return | osid.tracking.rules.QueueProcessorEnablerList | the returned QueueProcessorEnabler list | |
Errors | INVALID_ARGUMENT | from is greater tha to | |
NULL_ARGUMENT | agentId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known queue processor enablers or an error results. Otherwise, the returned list may contain only those queue processor enablers that are accessible through this session. In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned. | ||
Return | osid.tracking.rules.QueueProcessorEnablerList | the returned QueueProcessorEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |