Interface | osid.provisioning.QueueLookupSession | ||
---|---|---|---|
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 | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupQueues | ||
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 | useComparativeQueueView | ||
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 | usePlenaryQueueView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedDistributorView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedDistributorView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveQueueView | ||
Description |
Only active queues are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusQueueView | ||
Description |
Borth active and inactive queues are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueue | ||
Description |
Gets the In active mode, queues are returned that are currently active. In any status mode, active and inactive queues are returned. | ||
Parameters | osid.id.Id | queueId | Id of the Queue |
Return | osid.provisioning.Queue | the queue | |
Errors | NOT_FOUND | queueId not found | |
NULL_ARGUMENT | queueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueuesByIds | ||
Description |
Gets a In active mode, queues are returned that are currently active. In any status mode, active and inactive queues are returned. | ||
Parameters | osid.id.IdList | queueIds | the list of Ids to retrieve |
Return | osid.provisioning.QueueList | the returned Queue list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | queueIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesByGenusType | ||
Description |
Gets a In active mode, queues are returned that are currently active. In any status mode, active and inactive queues are returned. | ||
Parameters | osid.type.Type | queueGenusType | a queue genus type |
Return | osid.provisioning.QueueList | the returned Queue list | |
Errors | NULL_ARGUMENT | queueGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesByParentGenusType | ||
Description |
Gets a In active mode, queues are returned that are currently active. In any status mode, active and inactive queues are returned. | ||
Parameters | osid.type.Type | queueGenusType | a queue genus type |
Return | osid.provisioning.QueueList | the returned Queue list | |
Errors | NULL_ARGUMENT | queueGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesByRecordType | ||
Description |
Gets a In active mode, queues are returned that are currently active. In any status mode, active and inactive queues are returned. | ||
Parameters | osid.type.Type | queueRecordType | a queue record type |
Return | osid.provisioning.QueueList | the returned Queue list | |
Errors | NULL_ARGUMENT | queueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesByProvider | ||
Description |
Gets a In active mode, queues are returned that are currently active. In any status mode, active and inactive queues are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.provisioning.QueueList | the returned Queue list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesForBroker | ||
Description |
Gets a In active mode, queues are returned that are currently active. In any status mode, active and inactive queues are returned. | ||
Parameters | osid.id.Id | brokerId | a broker Id |
Return | osid.provisioning.QueueList | the returned Queue list | |
Errors | NULL_ARGUMENT | brokerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueues | ||
Description |
Gets all 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. | ||
Return | osid.provisioning.QueueList | a list of Queues | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |