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

This session provides methods for retrieving Queues. The Queue represents a set of pools .

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 methods in this session operate, retrieve and pertain to queues defined explicitly in the current distributor. Using an isolated view is useful for managing Queues with the QueueAdminSession.
  • federated distributor view: All queue methods in this session operate, retrieve and pertain to all queues defined in this distributor and any other queues implicitly available in this distributor through distributor inheritence.
  • active queue view: active queues are returned from methods in this session
  • any status queue view: active and inactive queues are returned from methods in this session

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.
MethodcanLookupQueues
Description

Tests if this user can perform Queue 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.
MethoduseComparativeQueueView
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.
MethodusePlenaryQueueView
Description

A complete view of the QueueConstrainer 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 constrainers 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.
MethoduseActiveQueueView
Description

Only active queues are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusQueueView
Description

Borth active and inactive queues are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetQueue
Description

Gets the Queue specified by its Id.

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

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

Parametersosid.id.IdqueueId Id of the Queue
Returnosid.provisioning.Queuethe queue
ErrorsNOT_FOUND queueId not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetQueuesByIds
Description

Gets a QueueList corresponding to the given IdList.

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

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

Parametersosid.id.IdListqueueIdsthe list of Ids to retrieve
Returnosid.provisioning.QueueListthe returned Queue list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT queueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueuesByGenusType
Description

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

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

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

Parametersosid.type.TypequeueGenusTypea queue genus type
Returnosid.provisioning.QueueListthe returned Queue list
ErrorsNULL_ARGUMENT queueGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueuesByParentGenusType
Description

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

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

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

Parametersosid.type.TypequeueGenusTypea queue genus type
Returnosid.provisioning.QueueListthe returned Queue list
ErrorsNULL_ARGUMENT queueGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueuesByRecordType
Description

Gets a QueueList containing the given queue record Type.

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

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

Parametersosid.type.TypequeueRecordTypea queue record type
Returnosid.provisioning.QueueListthe returned Queue list
ErrorsNULL_ARGUMENT queueRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueuesByProvider
Description

Gets a QueueList by provider.

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

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

Parametersosid.id.IdresourceIda resource Id
Returnosid.provisioning.QueueListthe returned Queue list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueuesForBroker
Description

Gets a QueueList by broker .

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

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

Parametersosid.id.IdbrokerIda broker Id
Returnosid.provisioning.QueueListthe returned Queue list
ErrorsNULL_ARGUMENT brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueues
Description

Gets all Queues.

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

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

Returnosid.provisioning.QueueLista list of Queues
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.