OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueProcessorEnablerLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving QueueProcessorEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated front office view: All queue processor enabler methods in this session operate, retrieve and pertain to queue processor enablers defined explicitly in the current front office. Using an isolated view is useful for managing QueueProcessorEnablers with the QueueProcessorEnablerAdminSession.
  • federated front office view: All queue processor enabler methods in this session operate, retrieve and pertain to all queue processor enablers defined in this front office and any other queue processor enablers implicitly available in this front office through front office inheritence.
  • actuve queue processor enabler view: All queue processor enabler lookup methods return active queue processor enablers.
  • any stayus queue processor enabler view: Queue processor enablers of any active or inactive status are returned from methods.

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 useFederatedFrontOfficeView() and useIsolatedFrontOfficeView() behave as a radio group and one should be selected before invoking the methods in this session.

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Idthe FrontOffice Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOfficethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupQueueProcessorEnablers
Description

Tests if this user can perform QueueProcessorEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeQueueProcessorEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryQueueProcessorEnablerView
Description

A complete view of the QueueProcessorEnabler returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedFrontOfficeView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFrontOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this front office only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveQueueProcessorEnablerView
Description

Only active queue processor enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusQueueProcessorEnablerView
Description

All active and inactive queue processor enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetQueueProcessorEnabler
Description

Gets the QueueProcessorEnabler specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned QueueProcessorEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a QueueProcessorEnabler and retained for compatibility.

In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned.

Parametersosid.id.IdqueueProcessorEnablerId Id of the QueueProcessorEnabler
Returnosid.tracking.rules.QueueProcessorEnablerthe queue processor enabler
ErrorsNOT_FOUND queueProcessorEnablerId not found
NULL_ARGUMENT queueProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetQueueProcessorEnablersByIds
Description

Gets a QueueProcessorEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the queue processor enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible QueueProcessorEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned.

Parametersosid.id.IdListqueueProcessorEnablerIdsthe list of Ids to retrieve
Returnosid.tracking.rules.QueueProcessorEnablerListthe returned QueueProcessorEnabler list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT queueProcessorEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablersByGenusType
Description

Gets a QueueProcessorEnablerList corresponding to the given queue processor enabler genus Type which does not include queue processor enablers of genus types derived from the specified Type.

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.

Parametersosid.type.TypequeueProcessorEnablerGenusTypea queue processor enabler genus type
Returnosid.tracking.rules.QueueProcessorEnablerListthe returned QueueProcessorEnabler list
ErrorsNULL_ARGUMENT queueProcessorEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablersByParentGenusType
Description

Gets a QueueProcessorEnablerList corresponding to the given queue processor enabler genus Type and include any additional queue processor enablers with genus types derived from the specified Type.

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.

Parametersosid.type.TypequeueProcessorEnablerGenusTypea queue processor enabler genus type
Returnosid.tracking.rules.QueueProcessorEnablerListthe returned QueueProcessorEnabler list
ErrorsNULL_ARGUMENT queueProcessorEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablersByRecordType
Description

Gets a QueueProcessorEnablerList containing the given queue processor enabler record Type.

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.

Parametersosid.type.TypequeueProcessorEnablerRecordTypea queue processor enabler record type
Returnosid.tracking.rules.QueueProcessorEnablerListthe returned QueueProcessorEnabler list
ErrorsNULL_ARGUMENT queueProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablersOnDate
Description

Gets a QueueProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.

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.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.tracking.rules.QueueProcessorEnablerListthe returned QueueProcessorEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablersOnDateWithAgent
Description

Gets a QueueProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.

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.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.tracking.rules.QueueProcessorEnablerListthe returned QueueProcessorEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablers
Description

Gets all QueueProcessorEnablers.

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.

Returnosid.tracking.rules.QueueProcessorEnablerListthe returned QueueProcessorEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.