OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.ProvisioningManager
Implementsosid.OsidManager
osid.provisioning.ProvisioningProfile
Used Byosid.orchestration.OrchestrationManager
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.MyProvisionSession a MyProvisionSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsMyProvision() is false
Complianceoptional This 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.IddistributorId the Id of the distrivutor
Returnosid.provisioning.MyProvisionSession a MyProvisionSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distriobutor is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsMyProvision() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsMyProvision() and supportsVisibleFederation() are true
MethodgetMySupplierSession
Description

Gets the OsidSession associated with the my supplier service.

Returnosid.provisioning.MySupplierSession a MySupplierSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsMySupplier() is false
Complianceoptional This 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.IddistributorId the Id of the distrivutor
Returnosid.provisioning.MySupplierSession a MySupplierSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distriobutor is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsMySupplier() or supportsVisibleFederation() is false
Complianceoptional This 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.ProvisionReceiverprovisionReceiver the notification callback
Returnosid.provisioning.MyProvisionNotificationSession a MyProvisionNotificationSession
ErrorsNULL_ARGUMENT provisionReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsMyProvisionNotification() is false
Complianceoptional This 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.ProvisionReceiverprovisionReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.MyProvisionNotificationSession a MyProvisionNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT provisionReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsMyProvisionNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsMyProvisionNotification() and supportsVisibleFederation() are true
MethodgetProvisionLookupSession
Description

Gets the OsidSession associated with the provision lookup service.

Returnosid.provisioning.ProvisionLookupSession a ProvisionLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionLookup() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.ProvisionLookupSession a ProvisionLookupSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionLookup() and supportsVisibleFederation() are true
MethodgetProvisionQuerySession
Description

Gets the OsidSession associated with the provision query service.

Returnosid.provisioning.ProvisionQuerySession a ProvisionQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionQuery() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.ProvisionQuerySession a ProvisionQuerySession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionQuery() and supportsVisibleFederation() are true
MethodgetProvisionSearchSession
Description

Gets the OsidSession associated with the provision search service.

Returnosid.provisioning.ProvisionSearchSession a ProvisionSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionSearch() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.ProvisionSearchSession a ProvisionSearchSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionSearch() and supportsVisibleFederation() are true
MethodgetProvisionAdminSession
Description

Gets the OsidSession associated with the provision administration service.

Returnosid.provisioning.ProvisionAdminSession a ProvisionAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionAdmin() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.ProvisionAdminSession a ProvisionAdminSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionAdmin() and supportsVisibleFederation() are true
MethodgetProvisionNotificationSession
Description

Gets the OsidSession associated with the provision notification service.

Parametersosid.provisioning.ProvisionReceiverprovisionReceiver the notification callback
Returnosid.provisioning.ProvisionNotificationSession a ProvisionNotificationSession
ErrorsNULL_ARGUMENT provisionReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionNotification() is false
Complianceoptional This 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.ProvisionReceiverprovisionReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.ProvisionNotificationSession a ProvisionNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT provisionReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionNotification() and supportsVisibleFederation() are true
MethodgetProvisionDistributorSession
Description

Gets the OsidSession to lookup provision/distributor mappings.

Returnosid.provisioning.ProvisionDistributorSession a ProvisionDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionDistributor() is false
Complianceoptional This method must be implemented if supportsProvisionDistributor() is true.
MethodgetProvisionDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provisions to distributors.

Returnosid.provisioning.ProvisionDistributorAssignmentSession a ProvisionDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsProvisionDistributorAssignment() is true.
MethodgetProvisionSmartDistributorSession
Description

Gets the OsidSession to manage provision smart distributors.

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.ProvisionDistributorSession a ProvisionSmartDistributorSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionSmartDistributor() is false
Complianceoptional This method must be implemented if supportsProvisionSmartDistributor() is true.
MethodgetProvisionReturnSession
Description

Gets the OsidSession associated with the provision return service.

Returnosid.provisioning.ProvisionReturnSession a ProvisionReturnSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionReturn() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.ProvisionReturnSession a ProvisionReturnSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionReturn() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionReturn() and supportsVisibleFederation() are true
MethodgetQueueLookupSession
Description

Gets the OsidSession associated with the queue lookup service.

Returnosid.provisioning.QueueLookupSession a QueueLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueLookup() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.QueueLookupSession a QueueLookupSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsQueueLookup() and supportsVisibleFederation() are true
MethodgetQueueQuerySession
Description

Gets the OsidSession associated with the queue query service.

Returnosid.provisioning.QueueQuerySession a QueueQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueQuery() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.QueueQuerySession a QueueQuerySession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsQueueQuery() and supportsVisibleFederation() are true
MethodgetQueueSearchSession
Description

Gets the OsidSession associated with the queue search service.

Returnosid.provisioning.QueueSearchSession a QueueSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueSearch() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.QueueSearchSession a QueueSearchSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsQueueSearch() and supportsVisibleFederation() are true
MethodgetQueueAdminSession
Description

Gets the OsidSession associated with the queue administration service.

Returnosid.provisioning.QueueAdminSession a QueueAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueAdmin() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.QueueAdminSession a QueueAdminSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsQueueAdmin() and supportsVisibleFederation() are true
MethodgetQueueNotificationSession
Description

Gets the OsidSession associated with the queue notification service.

Parametersosid.provisioning.QueueReceiverqueueReceiver the notification callback
Returnosid.provisioning.QueueNotificationSession a QueueNotificationSession
ErrorsNULL_ARGUMENT queueReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueNotification() is false
Complianceoptional This 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.QueueReceiverqueueReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.QueueNotificationSession a QueueNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT queueReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsQueueNotification() and supportsVisibleFederation() are true
MethodgetQueueDistributorSession
Description

Gets the OsidSession to lookup queue/distributor mappings.

Returnosid.provisioning.QueueDistributorSession a QueueDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueDistributor() is false
Complianceoptional This method must be implemented if supportsQueueDistributor() is true.
MethodgetQueueDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queues to distributors.

Returnosid.provisioning.QueueDistributorAssignmentSession a QueueDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsQueueDistributorAssignment() is true.
MethodgetQueueSmartDistributorSession
Description

Gets the OsidSession to manage queue smart distributors.

Parametersosid.id.IddistributorId the Id of the distributor
Returnosid.provisioning.QueueSmartDistributorSession a QueueSmartDistributorSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueSmartDistributor() is false
Complianceoptional This method must be implemented if supportsQueueSmartDistributor() is true.
MethodgetRequestLookupSession
Description

Gets the OsidSession associated with the request lookup service.

Returnosid.provisioning.RequestLookupSession a RequestLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestLookup() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestLookupSession a RequestLookupSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestLookup() and supportsVisibleFederation() are true
MethodgetRequestQuerySession
Description

Gets the OsidSession associated with the request query service.

Returnosid.provisioning.RequestQuerySession a RequestQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestQuery() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestQuerySession a CRequestQuerySession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestQuery() and supportsVisibleFederation() are true
MethodgetRequestSearchSession
Description

Gets the OsidSession associated with the request search service.

Returnosid.provisioning.RequestSearchSession a RequestSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestSearch() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestSearchSession a RequestSearchSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestSearch() and supportsVisibleFederation() are true
MethodgetRequestAdminSession
Description

Gets the OsidSession associated with the request administrative service.

Returnosid.provisioning.RequestAdminSession a RequestAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestAdmin() is false
Complianceoptional This 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.IdqueueId the Id of the Queue
Returnosid.provisioning.RequestAdminSession a RequestAdminSession
ErrorsNOT_FOUND no Queue found by the given Id
NULL_ARGUMENT queueId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestAdmin() and supportsVisibleFederation() are true
MethodgetRequestNotificationSession
Description

Gets the OsidSession associated with the request notification service.

Parametersosid.provisioning.RequestReceiverrequestReceiver the notification callback
Returnosid.provisioning.RequestNotificationSession a RequestNotificationSession
ErrorsNULL_ARGUMENT requestReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestNotification() is false
Complianceoptional This 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.RequestReceiverrequestReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestNotificationSession a RequestNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT requestReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestNotification() and supportsVisibleFederation() are true
MethodgetRequestDistributorSession
Description

Gets the OsidSession to lookup request/distributor mappings.

Returnosid.provisioning.RequestDistributorSession a RequestDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestDistributor() is false
Complianceoptional This method must be implemented if supportsRequestyDistributor() is true.
MethodgetRequestDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queues to distributors.

Returnosid.provisioning.RequestDistributorAssignmentSession a RequestyDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsRequestDistributorAssignment() is true.
MethodgetRequestSmartDistributorSession
Description

Gets the OsidSession to manage request smart distributors.

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestSmartDistributorSession a RequestSmartDistributorSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestSmartDistributor() is false
Complianceoptional This method must be implemented if supportsRequestSmartDistributor() is true.
MethodgetRequestTransactionLookupSession
Description

Gets the OsidSession associated with the request transaction lookup service.

Returnosid.provisioning.RequestTransactionLookupSession a RequestTransactionLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionLookup() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestTransactionLookupSession a RequestTransactionLookupSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestTransactionLookup() and supportsVisibleFederation() are true
MethodgetRequestTransactionAdminSession
Description

Gets the OsidSession associated with the request transaction administrative service.

Returnosid.provisioning.RequestTransactionAdminSession a RequestTransactionAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionAdmin() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestTransactionAdminSession a RequestTransactionAdminSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestTransactionAdmin() and supportsVisibleFederation() are true
MethodgetRequestTransactionQuerySession
Description

Gets the OsidSession associated with the request transaction query service.

Returnosid.provisioning.RequestTransactionQuerySession a RequestTransactionQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionQuery() is false
Complianceoptional This method must be implemented if supportsRequestTransactionQuery() is true.
MethodgetRequestTransactionQuerySessionForDistributor
Description

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

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestTransactionQuerySession a RequestTransactionQuerySession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestTransactionQuery() and supportsVisibleFederation() are true
MethodgetRequestTransactionSearchSession
Description

Gets the OsidSession associated with the request transaction search service.

Returnosid.provisioning.RequestTransactionSearchSession a RequestTransactionSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionSearch() is false
Complianceoptional This method must be implemented if supportsRequestTransactionSearch() is true.
MethodgetRequestTransactionSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestTransactionSearchSession a RequestTransactionSearchSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestTransactionSearch() and supportsVisibleFederation() are true
MethodgetRequestTransactionNotificationSession
Description

Gets the OsidSession associated with the request transaction notification service.

Parametersosid.provisioning.RequestTransactionReceiverrequestTransactionReceiver the notification callback
Returnosid.provisioning.RequestTransactionNotificationSession a RequestTransactionNotificationSession
ErrorsNULL_ARGUMENT requestTransactionReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionNotification() is false
Complianceoptional This method must be implemented if supportsRequestTransactionNotification() is true.
MethodgetRequestTransactionNotificationSessionForDistributor
Description

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

Parametersosid.provisioning.RequestTransactionReceiverrequestTransactionReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestTransactionNotificationSession a RequestTransactionNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT requestTransactionReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRequestTransactionNotification() and supportsVisibleFederation() are true
MethodgetRequestTransactionSmartDistributorSession
Description

Gets the OsidSession to manage request transaction smart distributors.

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestTransactionSmartDistributorSession a RequestTransactionSmartDistributorSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRequestTransactionSmartDistributor() is false
Complianceoptional This method must be implemented if supportsRequestTransactionSmartDistributor() is true .
MethodgetExchangeSession
Description

Gets the OsidSession associated with the exchange service.

Returnosid.provisioning.ExchangeSession an ExchangeSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsExchange() is false
Complianceoptional This method must be implemented if supportsExchange() is true.
MethodgetExchangeSessionForQueue
Description

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

Parametersosid.id.IdqueueId the Id of the Queue
Returnosid.provisioning.ExchangeSession an ExchangeSession
ErrorsNOT_FOUND no Queue found by the given Id
NULL_ARGUMENT queueId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsExchange() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsExchange() and supportsVisibleFederation() are true
MethodgetPoolLookupSession
Description

Gets the OsidSession associated with the pool lookup service.

Returnosid.provisioning.PoolLookupSession a PoolLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolLookup() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.PoolLookupSession a PoolLookupSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPoolLookup() and supportsVisibleFederation() are true
MethodgetPoolQuerySession
Description

Gets the OsidSession associated with the pool query service.

Returnosid.provisioning.PoolQuerySession a PoolQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolQuery() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.PoolQuerySession a PoolQuerySession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPoolQuery() and supportsVisibleFederation() are true
MethodgetPoolSearchSession
Description

Gets the OsidSession associated with the pool search service.

Returnosid.provisioning.PoolSearchSession a PoolSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolSearch() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.PoolSearchSession a PoolSearchSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPoolSearch() and supportsVisibleFederation() are true
MethodgetPoolAdminSession
Description

Gets the OsidSession associated with the pool administration service.

Returnosid.provisioning.PoolAdminSession a PoolAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolAdmin() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.PoolAdminSession a PoolAdminSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPoolAdmin() and supportsVisibleFederation() are true
MethodgetPoolNotificationSession
Description

Gets the OsidSession associated with the pool notification service.

Parametersosid.provisioning.PoolReceiverpoolReceiver the notification callback
Returnosid.provisioning.PoolNotificationSession a PoolNotificationSession
ErrorsNULL_ARGUMENT poolReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolNotification() is false
Complianceoptional This 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.PoolReceiverpoolReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.PoolNotificationSession a PoolNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT poolReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPoolNotification() and supportsVisibleFederation() are true
MethodgetPoolDistributorSession
Description

Gets the OsidSession to lookup pool/distributor mappings.

Returnosid.provisioning.PoolDistributorSession a PoolDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolDistributor() is false
Complianceoptional This method must be implemented if supportsPoolDistributor() is true.
MethodgetPoolDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pools to distributors.

Returnosid.provisioning.PoolDistributorAssignmentSession a PoolDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsPoolDistributorAssignment() is true.
MethodgetPoolSmartDistributorSession
Description

Gets the OsidSession to manage pool smart distributors.

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.PoolSmartDistributorSession a PoolSmartDistributorSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolSmartDistributor() is false
Complianceoptional This method must be implemented if supportsPoolSmartDistributor() is true.
MethodgetProvisionableLookupSession
Description

Gets the OsidSession associated with the provisionable lookup service.

Returnosid.provisioning.RequestLookupSession a ProvisionableLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableLookup() is false
Complianceoptional This 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.IddistributorId the Id of the distributor
Returnosid.provisioning.RequestLookupSession a ProvisionableLookupSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionableLookup() and supportsVisibleFederation() are true
MethodgetProvisionableQuerySession
Description

Gets the OsidSession associated with the provisionable query service.

Returnosid.provisioning.RequestQuerySession a ProvisionableQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableQuery() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestQuerySession a ProvisionableQuerySession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionableQuery() and supportsVisibleFederation() are true
MethodgetProvisionableSearchSession
Description

Gets the OsidSession associated with the provisionable search service.

Returnosid.provisioning.RequestSearchSession a ProvisionableSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableSearch() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestSearchSession a ProvisionableSearchSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionableSearch() and supportsVisibleFederation() are true
MethodgetProvisionableAdminSession
Description

Gets the OsidSession associated with the provisionable administration service.

Returnosid.provisioning.RequestAdminSession a ProvisionableAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableAdmin() is false
Complianceoptional This 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.IddistributorId the Id of the Dostributor
Returnosid.provisioning.RequestAdminSession a ProvisionableAdminSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionableAdmin() and supportsVisibleFederation() are true
MethodgetProvisionableNotificationSession
Description

Gets the OsidSession associated with the provisionable notification service.

Parametersosid.provisioning.RequestReceiverprovisionableReceiver the notification callback
Returnosid.provisioning.RequestNotificationSession a ProvisionableNotificationSession
ErrorsNULL_ARGUMENT provisionableReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableNotification() is false
Complianceoptional This 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.RequestReceiverprovisionableReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestNotificationSession a ProvisionableNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT provisionableReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProvisionableNotification() and supportsVisibleFederation() are true
MethodgetProvisionableDistributorSession
Description

Gets the OsidSession to lookup provisionable/distributor mappings.

Returnosid.provisioning.RequestDistributorSession a ProvisionableDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableDistributor() is false
Complianceoptional This method must be implemented if supportsProvisionableDistributor() is true.
MethodgetProvisionableDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provisionables to distributors.

Returnosid.provisioning.RequestDistributorAssignmentSession a ProvisionableDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsProvisionableDistributorAssignment() is true .
MethodgetProvisionableSmartDistributorSession
Description

Gets the OsidSession to manage locatin smart distributors.

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.RequestSmartDistributorSession a ProvisionableSmartDistributorSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableSmartDistributor() is false
Complianceoptional This method must be implemented if supportsProvisionableSmartDistributor() is true.
MethodgetBrokerLookupSession
Description

Gets the OsidSession associated with the broker lookup service.

Returnosid.provisioning.BrokerLookupSession a BrokerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerLookup() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.BrokerLookupSession a BrokerLookupSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBrokerLookup() and supportsVisibleFederation() are true
MethodgetBrokerQuerySession
Description

Gets the OsidSession associated with the broker query service.

Returnosid.provisioning.BrokerQuerySession a BrokerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerQuery() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.BrokerQuerySession a BrokerQuerySession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBrokerQuery() and supportsVisibleFederation() are true
MethodgetBrokerSearchSession
Description

Gets the OsidSession associated with the broker search service.

Returnosid.provisioning.BrokerSearchSession a BrokerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerSearch() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.BrokerSearchSession a BrokerSearchSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBrokerSearch() and supportsVisibleFederation() are true
MethodgetBrokerAdminSession
Description

Gets the OsidSession associated with the broker administration service.

Returnosid.provisioning.BrokerAdminSession a BrokerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerAdmin() is false
Complianceoptional This 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.IddistributorId the Id of the Distributor
Returnosid.provisioning.BrokerAdminSession a BrokerAdminSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBrokerAdmin() and supportsVisibleFederation() are true
MethodgetBrokerNotificationSession
Description

Gets the OsidSession associated with the broker notification service.

Parametersosid.provisioning.BrokerReceiverbrokerReceiver the notification callback
Returnosid.provisioning.BrokerNotificationSession a BrokerNotificationSession
ErrorsNULL_ARGUMENT brokerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerNotification() is false
Complianceoptional This 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.BrokerReceiverbrokerReceiver the notification callback
osid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.BrokerNotificationSession a BrokerNotificationSession
ErrorsNOT_FOUND no distributor found by the given Id
NULL_ARGUMENT brokerReceiver or distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBrokerNotification() and supportsVisibleFederation() are true
MethodgetBrokerDistributorSession
Description

Gets the OsidSession to lookup broker/distributor mappings.

Returnosid.provisioning.BrokerDistributorSession a BrokerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerDistributor() is false
Complianceoptional This method must be implemented if supportsBrokerDistributor() is true.
MethodgetBrokerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning brokers to distributors.

Returnosid.provisioning.BrokerDistributorAssignmentSession a BrokerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsBrokerDistributorAssignment() is true.
MethodgetBrokerSmartDistributorSession
Description

Gets the OsidSession to manage broker smart distributors.

Parametersosid.id.IddistributorId the Id of the Distributor
Returnosid.provisioning.BrokerSmartDistributorSession a BrokerSmartDistributorSession
ErrorsNOT_FOUND no Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerSmartDistributor() is false
Complianceoptional This method must be implemented if supportsBrokerSmartDistributor() is true.
MethodgetDistributorLookupSession
Description

Gets the OsidSession associated with the distributor lookup service.

Returnosid.provisioning.DistributorLookupSession a DistributorLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDistributorLookup() is false
Complianceoptional This method must be implemented if supportsDistributorLookup() is true.
MethodgetDistributorQuerySession
Description

Gets the OsidSession associated with the distributor query service.

Returnosid.provisioning.DistributorQuerySession a DistributorQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDistributorQuery() is false
Complianceoptional This method must be implemented if supportsDistributorQuery() is true.
MethodgetDistributorSearchSession
Description

Gets the OsidSession associated with the distributor search service.

Returnosid.provisioning.DistributorSearchSession a DistributorSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDistributorSearch() is false
Complianceoptional This method must be implemented if supportsDistributorSearch() is true.
MethodgetDistributorAdminSession
Description

Gets the OsidSession associated with the distributor administrative service.

Returnosid.provisioning.DistributorAdminSession a DistributorAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDistributorAdmin() is false
Complianceoptional This method must be implemented if supportsDistributorAdmin() is true.
MethodgetDistributorNotificationSession
Description

Gets the OsidSession associated with the distributor notification service.

Parametersosid.provisioning.DistributorReceiverdistributorReceiver the notification callback
Returnosid.provisioning.DistributorNotificationSession a DistributorNotificationSession
ErrorsNULL_ARGUMENT distributorReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDistributorNotification() is false
Complianceoptional This method must be implemented if supportsDistributorNotification() is true.
MethodgetDistributorHierarchySession
Description

Gets the OsidSession associated with the distributor hierarchy service.

Returnosid.provisioning.DistributorHierarchySession a DistributorHierarchySession for distributors
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDistributorHierarchy() is false
Complianceoptional This method must be implemented if supportsDistributorHierarchy() is true.
MethodgetDistributorHierarchyDesignSession
Description

Gets the OsidSession associated with the distributor hierarchy design service.

Returnosid.provisioning.DistributorHierarchyDesignSession a HierarchyDesignSession for distributors
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDistributorHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsDistributorHierarchyDesign() is true.
MethodgetProvisioningBatchManager
Description

Gets the ProvisioningBatchManager.

Returnosid.provisioning.batch.ProvisioningBatchManager a ProvisioningBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisioningBatch() is false
Complianceoptional This method must be implemented if supportsProvisioningBatch() is true.
MethodgetProvisioningRulesManager
Description

Gets the ProvisioningRulesManager.

Returnosid.provisioning.rules.ProvisioningRulesManager a ProvisioningRulesManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisioningRules() is false
Complianceoptional This method must be implemented if supportsProvisioningRules() is true.