Interface | osid.provisioning.rules.QueueProcessorLookupSession | ||
---|---|---|---|
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 | canLookupQueueProcessors | ||
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 | useComparativeQueueProcessorView | ||
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 | usePlenaryQueueProcessorView | ||
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 processor 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 | useActiveQueueProcessorView | ||
Description |
Only active queue processors are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusQueueProcessorView | ||
Description |
All active and inactive queue processors are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueProcessor | ||
Description |
Gets the In active mode, queue processors are returned that are currently active. In any status mode, active and inactive queue processors are returned. | ||
Parameters | osid.id.Id | queueProcessorId | Id of the QueueProcessor |
Return | osid.provisioning.rules.QueueProcessor | the queue processor | |
Errors | NOT_FOUND | queueProcessorId not found | |
NULL_ARGUMENT | queueProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueProcessorsByIds | ||
Description |
Gets a In active mode, queue processors are returned that are currently active. In any status mode, active and inactive queue processors are returned. | ||
Parameters | osid.id.IdList | queueProcessorIds | the list of Ids to retrieve |
Return | osid.provisioning.rules.QueueProcessorList | the returned QueueProcessor list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | queueProcessorIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorsByGenusType | ||
Description |
Gets a In active mode, queue processors are returned that are currently active. In any status mode, active and inactive queue processors are returned. | ||
Parameters | osid.type.Type | queueProcessorGenusType | a queue processor genus type |
Return | osid.provisioning.rules.QueueProcessorList | the returned QueueProcessor list | |
Errors | NULL_ARGUMENT | queueProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorsByParentGenusType | ||
Description |
Gets a In active mode, queue processors are returned that are currently active. In any status mode, active and inactive queue processors are returned. | ||
Parameters | osid.type.Type | queueProcessorGenusType | a queue processor genus type |
Return | osid.provisioning.rules.QueueProcessorList | the returned QueueProcessor list | |
Errors | NULL_ARGUMENT | queueProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorsByRecordType | ||
Description |
Gets a In active mode, queue processors are returned that are currently active. In any status mode, active and inactive queue processors are returned. | ||
Parameters | osid.type.Type | queueProcessorRecordType | a queue processor record type |
Return | osid.provisioning.rules.QueueProcessorList | the returned QueueProcessor list | |
Errors | NULL_ARGUMENT | queueProcessorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessors | ||
Description |
Gets all 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. | ||
Return | osid.provisioning.rules.QueueProcessorList | the returned QueueProcessor list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |