OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueProcessorLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving QueueProcessors.

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 distributor view: All queue processor methods in this session operate, retrieve and pertain to queue processor defined explicitly in the current distributor. Using an isolated view is useful for managing QueueProcessors with the QueueProcessorAdminSession.
  • federated distributor view: All queue processor methods in this session operate, retrieve and pertain to all queue processor defined in this distributor and any other queue processor implicitly available in this distributor through distributor inheritence.
  • active queue processor view: All queue processor lookup methods return active queue processors.
  • any status queue processor view: Queue processors of any active and 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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupQueueProcessors
Description

Tests if this user can perform QueueProcessors 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.
MethoduseComparativeQueueProcessorView
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.
MethodusePlenaryQueueProcessorView
Description

A complete view of the QueueProcessor 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.
MethoduseFederatedDistributorView
Description

Federates the view for methods in this session. A federated view will include queue processor in distributors which are children of this distributor in the distributor hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDistributorView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseActiveQueueProcessorView
Description

Only active queue processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusQueueProcessorView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetQueueProcessor
Description

Gets the QueueProcessor specified by its Id.

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

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

Parametersosid.id.IdqueueProcessorId Id of the QueueProcessor
Returnosid.provisioning.rules.QueueProcessorthe queue processor
ErrorsNOT_FOUND queueProcessorId not found
NULL_ARGUMENT queueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetQueueProcessorsByIds
Description

Gets a QueueProcessorList corresponding to the given IdList.

In plenary mode, the returned list contains all of the queue processor 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 QueueProcessors may be omitted from the list and may present the elements in any order including returning a unique set.

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

Parametersosid.id.IdListqueueProcessorIdsthe list of Ids to retrieve
Returnosid.provisioning.rules.QueueProcessorListthe returned QueueProcessor list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT queueProcessorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorsByGenusType
Description

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

In plenary mode, the returned list contains all known queue processor or an error results. Otherwise, the returned list may contain only those queue processor that are accessible through this session.

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

Parametersosid.type.TypequeueProcessorGenusTypea queue processor genus type
Returnosid.provisioning.rules.QueueProcessorListthe returned QueueProcessor list
ErrorsNULL_ARGUMENT queueProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorsByParentGenusType
Description

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

In plenary mode, the returned list contains all known queue processor or an error results. Otherwise, the returned list may contain only those queue processor that are accessible through this session.

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

Parametersosid.type.TypequeueProcessorGenusTypea queue processor genus type
Returnosid.provisioning.rules.QueueProcessorListthe returned QueueProcessor list
ErrorsNULL_ARGUMENT queueProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorsByRecordType
Description

Gets a QueueProcessorList containing the given queue processor record Type.

In plenary mode, the returned list contains all known queue processor or an error results. Otherwise, the returned list may contain only those queue processor that are accessible through this session.

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

Parametersosid.type.TypequeueProcessorRecordTypea queue processor record type
Returnosid.provisioning.rules.QueueProcessorListthe returned QueueProcessor list
ErrorsNULL_ARGUMENT queueProcessorRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessors
Description

Gets all QueueProcessors.

In plenary mode, the returned list contains all known queue processor or an error results. Otherwise, the returned list may contain only those queue processor that are accessible through this session.

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

Returnosid.provisioning.rules.QueueProcessorListthe returned QueueProcessor list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.