OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.ProvisioningManager
Implementsosid.OsidManager
osid.provisioning.ProvisioningProfile
Description

The provisioning manager provides access to provisioning sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • MyProvisionSession: a session for looking up queue information for authenticated agent
  • MySupplierSession: a session for looking up pool information for authenticated agent
  • MyProvisionNotificationSession: a session for subscribing to provision changes for authenticated agent
  • ProvisionLookupSession: a session to retrieve provisions
  • ProvisionQuerySession: a session to query for provisionss
  • ProvisionSearchSession: a session to search for provisions
  • ProvisionAdminSession: a session to create and delete provisions
  • ProvisionNotificationSession: a session to receive notifications pertaining to provision changes
  • ProvisionDistributorSession: a session to look up provision distributor mappings
  • ProvisionDistributorAssignmentSession: a session to manage provision to distributor mappings
  • ProvisionSmartDistributorSession: a session to manage dynamic distributors of provisions
  • ProvisionReturnSession: a session to return provisions
  • QueueLookupSession: a session to retrieve queues
  • QueueQuerySession: a session to query for queues
  • QueueSearchSession: a session to search for queues
  • QueueAdminSession: a session to create and delete queues
  • QueueNotificationSession: a session to receive notifications pertaining to queue changes
  • QueueDistributorSession: a session to look up queue distributor mappings
  • QueueDistributorAssignmentSession: a session to manage queue to distributor mappings
  • QueueSmartDistributorSession: a session to manage dynamic distributors of queues
  • RequestLookupSession: a session to retrieve requests
  • RequestQuerySession: a session to query for requests
  • RequestSearchSession: a session to search for requests
  • RequestAdminSession: a session to create and delete requests
  • RequestNotificationSession: a session to receive notifications pertaining to request changes
  • RequestDistributorSession: a session to look up request distributor mappings
  • RequestDistributorAssignmentSession: a session to manage request to distributor mappings
  • RequestSmartDistributorSession: a session to manage dynamic distributors of requests
  • RequestTransactionLookupSession: a session to retrieve request transactions
  • RequestTransactionAdminSession: a session to create and delete request transactions
  • ExchangeSession: a session to exchange provisions
  • PoolLookupSession: a session to retrieve pools
  • PoolQuerySession: a session to query for pools
  • PoolSearchSession: a session to search for pools
  • PoolAdminSession: a session to create and delete pools
  • PoolNotificationSession: a session to receive notifications pertaining to pool changes
  • PoolDistributorSession: a session to look up pool distributor mappings
  • PoolDistributorAssignmentSession: a session to manage pools to distributor mappings
  • PoolSmartDistributorSession: a session to manage dynamic distributors of pools
  • ProvisionableLookupSession: a session to retrieve provisionables
  • ProvisionableQuerySession: a session to query for provisionables
  • ProvisionableSearchSession: a session to search for provisionables
  • ProvisionableAdminSession: a session to create and delete provisionables
  • ProvisionableNotificationSession: a session to receive notifications pertaining to provisionable changes
  • ProvisionableDistributorsSession: a session to look up provisionable distributors mappings
  • ProvisionableDistributorAssignmentSession: a session to manage provisionable to distributor mappings
  • ProvisionableSmartDistributorSession: a session to manage dynamic distributors of provisionables
  • BrokerLookupSession: a session to retrieve brokers
  • BrokerQuerySession: a session to query for brokers
  • BrokerSearchSession: a session to search for brokers
  • BrokerAdminSession: a session to create and delete brokers
  • BrokerNotificationSession: a session to receive notifications pertaining to broker changes
  • BrokerDistributorSession: a session to look up mappings of brokers to distributors
  • BrokerDistributorAssignmentSession: a session to manage broker to distributor mappings
  • BrokerSmartDistributorSession: a session to manage dynamic distributors of brokers
  • DistributorLookupSession: a session to retrieve distributors
  • DistributorQuerySession: a session to search for distributors
  • DistributorSearchSession: a session to search for distributors
  • DistributorAdminSession: a session to create and delete distributors
  • DistributorNotificationSession: a session to receive notifications pertaining to distributor changes
  • DistributorHierarchySession: a session to traverse a hierarchy of distributor
  • DistributorHierarchyDesignSession: a session to manage a distributor hierarchy
MethodgetMyProvisionSession
Description

Gets the OsidSession associated with the my provision service.

Returnosid.provisioning.MyProvisionSessiona MyProvisionSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyProvision() is false
ComplianceoptionalThis method must be implemented if supportsMyProvision() is true.
MethodgetMyProvisionSessionForDistributor
Description

Gets the OsidSession associated with the my provision service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the distrivutor
Returnosid.provisioning.MyProvisionSessiona MyProvisionSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distriobutor is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyProvision() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMyProvision() and supportsVisibleFederation() are true
MethodgetMySupplierSession
Description

Gets the OsidSession associated with the my supplier service.

Returnosid.provisioning.MySupplierSessiona MySupplierSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMySupplier() is false
ComplianceoptionalThis method must be implemented if supportsMySupplier() is true.
MethodgetMySupplierSessionForDistributor
Description

Gets the OsidSession associated with the my Supplier service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the distrivutor
Returnosid.provisioning.MySupplierSessiona MySupplierSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distriobutor is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMySupplier() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMySupplier() and supportsVisibleFederation() are true
MethodgetMyProvisionNotificationSession
Description

Gets the OsidSession associated with the provision notification service for resources related to the authentciated agent.

Parametersosid.provisioning.ProvisionReceiverprovisionReceiverthe notification callback
Returnosid.provisioning.MyProvisionNotificationSessiona MyProvisionNotificationSession
ErrorsNULL_ARGUMENT provisionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyProvisionNotification() is false
ComplianceoptionalThis method must be implemented if supportsMyProvisionNotification() is true.
MethodgetMyProvisionNotificationSessionForDistributor
Description

Gets the OsidSession associated with the provision notification service for the given distributor for resources related to the authentciated agent.

Parametersosid.provisioning.ProvisionReceiverprovisionReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.MyProvisionNotificationSessiona MyProvisionNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT provisionReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyProvisionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMyProvisionNotification() and supportsVisibleFederation() are true
MethodgetProvisionLookupSession
Description

Gets the OsidSession associated with the provision lookup service.

Returnosid.provisioning.ProvisionLookupSessiona ProvisionLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionLookup() is false
ComplianceoptionalThis method must be implemented if supportsProvisionLookup() is true.
MethodgetProvisionLookupSessionForDistributor
Description

Gets the OsidSession associated with the provision lookup service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.ProvisionLookupSessiona ProvisionLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionLookup() and supportsVisibleFederation() are true
MethodgetProvisionQuerySession
Description

Gets the OsidSession associated with the provision query service.

Returnosid.provisioning.ProvisionQuerySessiona ProvisionQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionQuery() is false
ComplianceoptionalThis method must be implemented if supportsProvisionQuery() is true.
MethodgetProvisionQuerySessionForDistributor
Description

Gets the OsidSession associated with the provision query service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.ProvisionQuerySessiona ProvisionQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionQuery() and supportsVisibleFederation() are true
MethodgetProvisionSearchSession
Description

Gets the OsidSession associated with the provision search service.

Returnosid.provisioning.ProvisionSearchSessiona ProvisionSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionSearch() is false
ComplianceoptionalThis method must be implemented if supportsProvisionSearch() is true.
MethodgetProvisionSearchSessionForDistributor
Description

Gets the OsidSession associated with the provision search service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.ProvisionSearchSessiona ProvisionSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionSearch() and supportsVisibleFederation() are true
MethodgetProvisionAdminSession
Description

Gets the OsidSession associated with the provision administration service.

Returnosid.provisioning.ProvisionAdminSessiona ProvisionAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProvisionAdmin() is true.
MethodgetProvisionAdminSessionForDistributor
Description

Gets the OsidSession associated with the provision administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.ProvisionAdminSessiona ProvisionAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionAdmin() and supportsVisibleFederation() are true
MethodgetProvisionNotificationSession
Description

Gets the OsidSession associated with the provision notification service.

Parametersosid.provisioning.ProvisionReceiverprovisionReceiverthe notification callback
Returnosid.provisioning.ProvisionNotificationSessiona ProvisionNotificationSession
ErrorsNULL_ARGUMENT provisionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionNotification() is false
ComplianceoptionalThis method must be implemented if supportsProvisionNotification() is true.
MethodgetProvisionNotificationSessionForDistributor
Description

Gets the OsidSession associated with the provision notification service for the given distributor.

Parametersosid.provisioning.ProvisionReceiverprovisionReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.ProvisionNotificationSessiona ProvisionNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT provisionReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionNotification() and supportsVisibleFederation() are true
MethodgetProvisionDistributorSession
Description

Gets the OsidSession to lookup provision/distributor mappings.

Returnosid.provisioning.ProvisionDistributorSessiona ProvisionDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionDistributor() is true.
MethodgetProvisionDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provisions to distributors.

Returnosid.provisioning.ProvisionDistributorAssignmentSessiona ProvisionDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProvisionDistributorAssignment() is true.
MethodgetProvisionSmartDistributorSession
Description

Gets the OsidSession to manage provision smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.ProvisionDistributorSessiona ProvisionSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionSmartDistributor() is true.
MethodgetProvisionReturnSession
Description

Gets the OsidSession associated with the provision return service.

Returnosid.provisioning.ProvisionReturnSessiona ProvisionReturnSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionReturn() is false
ComplianceoptionalThis method must be implemented if supportsProvisionReturn() is true.
MethodgetProvisionReturnSessionForDistributor
Description

Gets the OsidSession associated with the provision return service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.ProvisionReturnSessiona ProvisionReturnSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionReturn() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionReturn() and supportsVisibleFederation() are true
MethodgetQueueLookupSession
Description

Gets the OsidSession associated with the queue lookup service.

Returnosid.provisioning.QueueLookupSessiona QueueLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueLookup() is true.
MethodgetQueueLookupSessionForDistributor
Description

Gets the OsidSession associated with the queue lookup service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.QueueLookupSessiona QueueLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueLookup() and supportsVisibleFederation() are true
MethodgetQueueQuerySession
Description

Gets the OsidSession associated with the queue query service.

Returnosid.provisioning.QueueQuerySessiona QueueQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueQuery() is true.
MethodgetQueueQuerySessionForDistributor
Description

Gets the OsidSession associated with the queue query service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.QueueQuerySessiona QueueQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueQuery() and supportsVisibleFederation() are true
MethodgetQueueSearchSession
Description

Gets the OsidSession associated with the queue search service.

Returnosid.provisioning.QueueSearchSessiona QueueSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueSearch() is false
ComplianceoptionalThis method must be implemented if supportsQueueSearch() is true.
MethodgetQueueSearchSessionForDistributor
Description

Gets the OsidSession associated with the queue search service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.QueueSearchSessiona QueueSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueSearch() and supportsVisibleFederation() are true
MethodgetQueueAdminSession
Description

Gets the OsidSession associated with the queue administration service.

Returnosid.provisioning.QueueAdminSessiona QueueAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueAdmin() is true.
MethodgetQueueAdminSessionForDistributor
Description

Gets the OsidSession associated with the queue administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.QueueAdminSessiona QueueAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueAdmin() and supportsVisibleFederation() are true
MethodgetQueueNotificationSession
Description

Gets the OsidSession associated with the queue notification service.

Parametersosid.provisioning.QueueReceiverqueueReceiverthe notification callback
Returnosid.provisioning.QueueNotificationSessiona QueueNotificationSession
ErrorsNULL_ARGUMENT queueReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueNotification() is false
ComplianceoptionalThis method must be implemented if supportsQueueNotification() is true.
MethodgetQueueNotificationSessionForDistributor
Description

Gets the OsidSession associated with the queue notification service for the given distributor.

Parametersosid.provisioning.QueueReceiverqueueReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.QueueNotificationSessiona QueueNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT queueReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueNotification() and supportsVisibleFederation() are true
MethodgetQueueDistributorSession
Description

Gets the OsidSession to lookup queue/distributor mappings.

Returnosid.provisioning.QueueDistributorSessiona QueueDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueDistributor() is true.
MethodgetQueueDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queues to distributors.

Returnosid.provisioning.QueueDistributorAssignmentSessiona QueueDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueDistributorAssignment() is true.
MethodgetQueueSmartDistributorSession
Description

Gets the OsidSession to manage queue smart distributors.

Parametersosid.id.IddistributorIdthe Id of the distributor
Returnosid.provisioning.QueueSmartDistributorSessiona QueueSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueSmartDistributor() is true.
MethodgetRequestLookupSession
Description

Gets the OsidSession associated with the request lookup service.

Returnosid.provisioning.RequestLookupSessiona RequestLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestLookup() is false
ComplianceoptionalThis method must be implemented if supportsRequestLookup() is true.
MethodgetRequestLookupSessionForDistributor
Description

Gets the OsidSession associated with the request lookup service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestLookupSessiona RequestLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestLookup() and supportsVisibleFederation() are true
MethodgetRequestQuerySession
Description

Gets the OsidSession associated with the request query service.

Returnosid.provisioning.RequestQuerySessiona RequestQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestQuery() is false
ComplianceoptionalThis method must be implemented if supportsRequestQuery() is true.
MethodgetRequestQuerySessionForDistributor
Description

Gets the OsidSession associated with the request query service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestQuerySessiona CRequestQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestQuery() and supportsVisibleFederation() are true
MethodgetRequestSearchSession
Description

Gets the OsidSession associated with the request search service.

Returnosid.provisioning.RequestSearchSessiona RequestSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestSearch() is false
ComplianceoptionalThis method must be implemented if supportsRequestSearch() is true.
MethodgetRequestSearchSessionForDistributor
Description

Gets the OsidSession associated with the request search service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestSearchSessiona RequestSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestSearch() and supportsVisibleFederation() are true
MethodgetRequestAdminSession
Description

Gets the OsidSession associated with the request administrative service.

Returnosid.provisioning.RequestAdminSessiona RequestAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRequestAdmin() is true.
MethodgetRequestAdminSessionForQueue
Description

Gets the OsidSession associated with the request administrative service for the given queue.

Parametersosid.id.IdqueueIdthe Id of the Queue
Returnosid.provisioning.RequestAdminSessiona RequestAdminSession
ErrorsNOT_FOUNDno Queue found by the given Id
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestAdmin() and supportsVisibleFederation() are true
MethodgetRequestNotificationSession
Description

Gets the OsidSession associated with the request notification service.

Parametersosid.provisioning.RequestReceiverrequestReceiverthe notification callback
Returnosid.provisioning.RequestNotificationSessiona RequestNotificationSession
ErrorsNULL_ARGUMENT requestReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestNotification() is false
ComplianceoptionalThis method must be implemented if supportsRequestNotification() is true.
MethodgetRequestNotificationSessionForDistributor
Description

Gets the OsidSession associated with the request notification service for the given distributor.

Parametersosid.provisioning.RequestReceiverrequestReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestNotificationSessiona RequestNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT requestReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestNotification() and supportsVisibleFederation() are true
MethodgetRequestDistributorSession
Description

Gets the OsidSession to lookup request/distributor mappings.

Returnosid.provisioning.RequestDistributorSessiona RequestDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestDistributor() is false
ComplianceoptionalThis method must be implemented if supportsRequestyDistributor() is true.
MethodgetRequestDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queues to distributors.

Returnosid.provisioning.RequestDistributorAssignmentSessiona RequestyDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRequestDistributorAssignment() is true.
MethodgetRequestSmartDistributorSession
Description

Gets the OsidSession to manage request smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestSmartDistributorSessiona RequestSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsRequestSmartDistributor() is true.
MethodgetRequestTransactionLookupSession
Description

Gets the OsidSession associated with the request transaction lookup service.

Returnosid.provisioning.RequestTransactionLookupSessiona RequestTransactionLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestTransactionLookup() is false
ComplianceoptionalThis method must be implemented if supportsRequestTransactionLookup() is true.
MethodgetRequestTransactionLookupSessionForDistributor
Description

Gets the OsidSession associated with the request transaction lookup service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestTransactionLookupSessiona RequestTransactionLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestTransactionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestTransactionLookup() and supportsVisibleFederation() are true
MethodgetRequestTransactionAdminSession
Description

Gets the OsidSession associated with the request transaction administrative service.

Returnosid.provisioning.RequestTransactionAdminSessiona RequestTransactionAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestTransactionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRequestTransactionAdmin() is true.
MethodgetRequestTransactionAdminSessionForDistributor
Description

Gets the OsidSession associated with the request transaction administrative service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestTransactionAdminSessiona RequestTransactionAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestTransactionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestTransactionAdmin() and supportsVisibleFederation() are true
MethodgetExchangeSession
Description

Gets the OsidSession associated with the exchange service.

Returnosid.provisioning.ExchangeSessionan ExchangeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsExchange() is false
ComplianceoptionalThis method must be implemented if supportsExchange() is true.
MethodgetExchangeSessionForQueue
Description

Gets the OsidSession associated with the exchange service for the given queue.

Parametersosid.id.IdqueueIdthe Id of the Queue
Returnosid.provisioning.ExchangeSessionan ExchangeSession
ErrorsNOT_FOUNDno Queue found by the given Id
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsExchange() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsExchange() and supportsVisibleFederation() are true
MethodgetPoolLookupSession
Description

Gets the OsidSession associated with the pool lookup service.

Returnosid.provisioning.PoolLookupSessiona PoolLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolLookup() is false
ComplianceoptionalThis method must be implemented if supportsPoolLookup() is true.
MethodgetPoolLookupSessionForDistributor
Description

Gets the OsidSession associated with the pool lookup service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.PoolLookupSessiona PoolLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolLookup() and supportsVisibleFederation() are true
MethodgetPoolQuerySession
Description

Gets the OsidSession associated with the pool query service.

Returnosid.provisioning.PoolQuerySessiona PoolQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolQuery() is false
ComplianceoptionalThis method must be implemented if supportsPoolQuery() is true.
MethodgetPoolQuerySessionForDistributor
Description

Gets the OsidSession associated with the pool query service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.PoolQuerySessiona PoolQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolQuery() and supportsVisibleFederation() are true
MethodgetPoolSearchSession
Description

Gets the OsidSession associated with the pool search service.

Returnosid.provisioning.PoolSearchSessiona PoolSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolSearch() is false
ComplianceoptionalThis method must be implemented if supportsPoolSearch() is true.
MethodgetPoolSearchSessionForDistributor
Description

Gets the OsidSession associated with the pool search service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.PoolSearchSessiona PoolSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolSearch() and supportsVisibleFederation() are true
MethodgetPoolAdminSession
Description

Gets the OsidSession associated with the pool administration service.

Returnosid.provisioning.PoolAdminSessiona PoolAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPoolAdmin() is true.
MethodgetPoolAdminSessionForDistributor
Description

Gets the OsidSession associated with the pool administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.PoolAdminSessiona PoolAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolAdmin() and supportsVisibleFederation() are true
MethodgetPoolNotificationSession
Description

Gets the OsidSession associated with the pool notification service.

Parametersosid.provisioning.PoolReceiverpoolReceiverthe notification callback
Returnosid.provisioning.PoolNotificationSessiona PoolNotificationSession
ErrorsNULL_ARGUMENT poolReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolNotification() is false
ComplianceoptionalThis method must be implemented if supportsPoolNotification() is true.
MethodgetPoolNotificationSessionForDistributor
Description

Gets the OsidSession associated with the pool notification service for the given distributor.

Parametersosid.provisioning.PoolReceiverpoolReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.PoolNotificationSessiona PoolNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT poolReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolNotification() and supportsVisibleFederation() are true
MethodgetPoolDistributorSession
Description

Gets the OsidSession to lookup pool/distributor mappings.

Returnosid.provisioning.PoolDistributorSessiona PoolDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolDistributor() is true.
MethodgetPoolDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pools to distributors.

Returnosid.provisioning.PoolDistributorAssignmentSessiona PoolDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPoolDistributorAssignment() is true.
MethodgetPoolSmartDistributorSession
Description

Gets the OsidSession to manage pool smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.PoolSmartDistributorSessiona PoolSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolSmartDistributor() is true.
MethodgetProvisionableLookupSession
Description

Gets the OsidSession associated with the provisionable lookup service.

Returnosid.provisioning.RequestLookupSessiona ProvisionableLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableLookup() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableLookup() is true.
MethodgetProvisionableLookupSessionForDistributor
Description

Gets the OsidSession associated with the provisionable lookup service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the distributor
Returnosid.provisioning.RequestLookupSessiona ProvisionableLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableLookup() and supportsVisibleFederation() are true
MethodgetProvisionableQuerySession
Description

Gets the OsidSession associated with the provisionable query service.

Returnosid.provisioning.RequestQuerySessiona ProvisionableQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableQuery() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableQuery() is true.
MethodgetProvisionableQuerySessionForDistributor
Description

Gets the OsidSession associated with the provisionable query service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestQuerySessiona ProvisionableQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableQuery() and supportsVisibleFederation() are true
MethodgetProvisionableSearchSession
Description

Gets the OsidSession associated with the provisionable search service.

Returnosid.provisioning.RequestSearchSessiona ProvisionableSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableSearch() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableSearch() is true.
MethodgetProvisionableSearchSessionForDistributor
Description

Gets the OsidSession associated with the provisionable search service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestSearchSessiona ProvisionableSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableSearch() and supportsVisibleFederation() are true
MethodgetProvisionableAdminSession
Description

Gets the OsidSession associated with the provisionable administration service.

Returnosid.provisioning.RequestAdminSessiona ProvisionableAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableAdmin() is true.
MethodgetProvisionableAdminSessionForPool
Description

Gets the OsidSession associated with the provisionable administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Dostributor
Returnosid.provisioning.RequestAdminSessiona ProvisionableAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableAdmin() and supportsVisibleFederation() are true
MethodgetProvisionableNotificationSession
Description

Gets the OsidSession associated with the provisionable notification service.

Parametersosid.provisioning.RequestReceiverprovisionableReceiverthe notification callback
Returnosid.provisioning.RequestNotificationSessiona ProvisionableNotificationSession
ErrorsNULL_ARGUMENT provisionableReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableNotification() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableNotification() is true.
MethodgetProvisionableNotificationSessionForDistributor
Description

Gets the OsidSession associated with the provisionable notification service for the given distributor.

Parametersosid.provisioning.RequestReceiverprovisionableReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestNotificationSessiona ProvisionableNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT provisionableReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableNotification() and supportsVisibleFederation() are true
MethodgetProvisionableDistributorSession
Description

Gets the OsidSession to lookup provisionable/distributor mappings.

Returnosid.provisioning.RequestDistributorSessiona ProvisionableDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableDistributor() is true.
MethodgetProvisionableDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provisionables to distributors.

Returnosid.provisioning.RequestDistributorAssignmentSessiona ProvisionableDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableDistributorAssignment() is true.
MethodgetProvisionableSmartDistributorSession
Description

Gets the OsidSession to manage locatin smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.RequestSmartDistributorSessiona ProvisionableSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableSmartDistributor() is true.
MethodgetBrokerLookupSession
Description

Gets the OsidSession associated with the broker lookup service.

Returnosid.provisioning.BrokerLookupSessiona BrokerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerLookup() is false
ComplianceoptionalThis method must be implemented if supportsBrokerLookup() is true.
MethodgetBrokerLookupSessionForDistributor
Description

Gets the OsidSession associated with the broker lookup service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.BrokerLookupSessiona BrokerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerLookup() and supportsVisibleFederation() are true
MethodgetBrokerQuerySession
Description

Gets the OsidSession associated with the broker query service.

Returnosid.provisioning.BrokerQuerySessiona BrokerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerQuery() is false
ComplianceoptionalThis method must be implemented if supportsBrokerQuery() is true.
MethodgetBrokerQuerySessionForDistributor
Description

Gets the OsidSession associated with the broker query service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.BrokerQuerySessiona BrokerQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerQuery() and supportsVisibleFederation() are true
MethodgetBrokerSearchSession
Description

Gets the OsidSession associated with the broker search service.

Returnosid.provisioning.BrokerSearchSessiona BrokerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerSearch() is true.
MethodgetBrokerSearchSessionForDistributor
Description

Gets the OsidSession associated with the broker search service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.BrokerSearchSessiona BrokerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerSearch() and supportsVisibleFederation() are true
MethodgetBrokerAdminSession
Description

Gets the OsidSession associated with the broker administration service.

Returnosid.provisioning.BrokerAdminSessiona BrokerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBrokerAdmin() is true.
MethodgetBrokerAdminSessionForDistributor
Description

Gets the OsidSession associated with the broker administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.BrokerAdminSessiona BrokerAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerAdmin() and supportsVisibleFederation() are true
MethodgetBrokerNotificationSession
Description

Gets the OsidSession associated with the broker notification service.

Parametersosid.provisioning.BrokerReceiverbrokerReceiverthe notification callback
Returnosid.provisioning.BrokerNotificationSessiona BrokerNotificationSession
ErrorsNULL_ARGUMENT brokerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerNotification() is false
ComplianceoptionalThis method must be implemented if supportsBrokerNotification() is true.
MethodgetBrokerNotificationSessionForDistributor
Description

Gets the OsidSession associated with the broker notification service for the given distributor.

Parametersosid.provisioning.BrokerReceiverbrokerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.BrokerNotificationSessiona BrokerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT brokerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerNotification() and supportsVisibleFederation() are true
MethodgetBrokerDistributorSession
Description

Gets the OsidSession to lookup broker/distributor mappings.

Returnosid.provisioning.BrokerDistributorSessiona BrokerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerDistributor() is true.
MethodgetBrokerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning brokers to distributors.

Returnosid.provisioning.BrokerDistributorAssignmentSessiona BrokerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBrokerDistributorAssignment() is true.
MethodgetBrokerSmartDistributorSession
Description

Gets the OsidSession to manage broker smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.BrokerSmartDistributorSessiona BrokerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerSmartDistributor() is true.
MethodgetDistributorLookupSession
Description

Gets the OsidSession associated with the distributor lookup service.

Returnosid.provisioning.DistributorLookupSessiona DistributorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorLookup() is false
ComplianceoptionalThis method must be implemented if supportsDistributorLookup() is true.
MethodgetDistributorQuerySession
Description

Gets the OsidSession associated with the distributor query service.

Returnosid.provisioning.DistributorQuerySessiona DistributorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorQuery() is false
ComplianceoptionalThis method must be implemented if supportsDistributorQuery() is true.
MethodgetDistributorSearchSession
Description

Gets the OsidSession associated with the distributor search service.

Returnosid.provisioning.DistributorSearchSessiona DistributorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorSearch() is false
ComplianceoptionalThis method must be implemented if supportsDistributorSearch() is true.
MethodgetDistributorAdminSession
Description

Gets the OsidSession associated with the distributor administrative service.

Returnosid.provisioning.DistributorAdminSessiona DistributorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDistributorAdmin() is true.
MethodgetDistributorNotificationSession
Description

Gets the OsidSession associated with the distributor notification service.

Parametersosid.provisioning.DistributorReceiverdistributorReceiverthe notification callback
Returnosid.provisioning.DistributorNotificationSessiona DistributorNotificationSession
ErrorsNULL_ARGUMENT distributorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorNotification() is false
ComplianceoptionalThis method must be implemented if supportsDistributorNotification() is true.
MethodgetDistributorHierarchySession
Description

Gets the OsidSession associated with the distributor hierarchy service.

Returnosid.provisioning.DistributorHierarchySessiona DistributorHierarchySession for distributors
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsDistributorHierarchy() is true.
MethodgetDistributorHierarchyDesignSession
Description

Gets the OsidSession associated with the distributor hierarchy design service.

Returnosid.provisioning.DistributorHierarchyDesignSessiona HierarchyDesignSession for distributors
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsDistributorHierarchyDesign() is true.
MethodgetProvisioningBatchManager
Description

Gets the ProvisioningBatchManager.

Returnosid.provisioning.batch.ProvisioningBatchManagera ProvisioningBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisioningBatch() is false
ComplianceoptionalThis method must be implemented if supportsProvisioningBatch() is true.
MethodgetProvisioningRulesManager
Description

Gets the ProvisioningRulesManager.

Returnosid.provisioning.rules.ProvisioningRulesManagera ProvisioningRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisioningRules() is false
ComplianceoptionalThis method must be implemented if supportsProvisioningRules() is true.