OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.ProvisioningRulesManager
Implementsosid.OsidManager
osid.provisioning.rules.ProvisioningRulesProfile
Used Byosid.provisioning.ProvisioningManager
Description

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

  • BrokerEnablerLookupSession: a session to retrieve broker enablers
  • BrokerEnablerQuerySession: a session to query for broker enablers
  • BrokerEnablerSearchSession: a session to search for broker enablers
  • BrokerEnablerAdminSession: a session to create and delete broker enablers
  • BrokerEnablerNotificationSession: a session to receive notifications pertaining to broker enabler changes
  • BrokerEnablerDistributorSession: a session to look up broker enabler distributor mappings
  • BrokerEnablerDistributorAssignmentSession: a session to manage broker enabler to distributor mappings
  • BrokerEnablerSmartDistributorSession: a session to manage dynamic distributors of broker enablers
  • BrokerEnablerRuleLookupSession: a session to look up broker enablers to broker mappings
  • BrokerEnablerRuleApplicationSession: a session to apply broker enablers to brokers
  • BrokerConstrainerLookupSession: a session to retrieve broker constrainers
  • BrokerConstrainerQuerySession: a session to query for broker constrainers
  • BrokerConstrainerSearchSession: a session to search for broker constrainers
  • BrokerConstrainerAdminSession: a session to create and delete broker constrainers
  • BrokerConstrainerNotificationSession: a session to receive notifications pertaining to broker constrainer changes
  • BrokerConstrainerDistributorSession: a session to look up broker constrainer distributor mappings
  • BrokerConstrainerDistributorAssignmentSession : a session to manage broker constrainer to distributor mappings
  • BrokerConstrainerSmartDistributorSession : a session to manage dynamic distributors of broker constrainers
  • BrokerConstrainerRuleLookupSession: a session to look up broker constrainers to broker mappings
  • BrokerConstrainerRuleApplicationSession: a session to apply broker constrainers to brokers
  • BrokerConstrainerEnablerLookupSession: a session to retrieve broker constrainer enablers
  • BrokerConstrainerEnablerQuerySession: a session to query for broker constrainer enablers
  • BrokerConstrainerEnablerSearchSession: a session to search for broker constrainer enablers
  • BrokerConstrainerEnablerAdminSession: a session to create and delete broker constrainer enablers
  • BrokerConstrainerEnablerNotificationSession: a session to receive notifications pertaining to broker constrainer enabler changes
  • BrokerConstrainerEnablerDistributorSession: a session to look up broker constrainer enabler distributor mappings
  • BrokerConstrainerEnablerDistributorAssignmentSession : a session to manage broker constrainer enabler to distributor mappings
  • BrokerConstrainerEnablerSmartDistributorSession : a session to manage dynamic distributors of broker constrainer enablers
  • BrokerConstrainerEnablerRuleLookupSession: a session to look up broker constrainer enablers to broker constrainer mappings
  • BrokerConstrainerEnablerRuleApplicationSession : a session to apply broker constrainer enablers to broker constrainers
  • BrokerProcessorLookupSession: a session to retrieve broker processors
  • BrokerProcessorQuerySession: a session to query for broker processors
  • BrokerProcessorSearchSession: a session to search for broker processors
  • BrokerProcessorAdminSession: a session to create and delete broker processors
  • BrokerProcessorNotificationSession: a session to receive notifications pertaining to broker processor changes
  • BrokerProcessorDistributorSession: a session to look up broker processor distributor mappings
  • BrokerProcessorDistributorAssignmentSession: a session to manage broker processor to distributor mappings
  • BrokerProcessorSmartDistributorSession: a session to manage dynamic distributors of broker processors
  • BrokerProcessorRuleLookupSession: a session to look up broker processors to broker mappings
  • BrokerProcessorRuleApplicationSession: a session to apply broker processors to brokers
  • BrokerProcessorEnablerLookupSession: a session to retrieve broker processor enablers
  • BrokerProcessorEnablerQuerySession: a session to query for broker processor enablers
  • BrokerProcessorEnablerSearchSession: a session to search for broker processor enablers
  • BrokerProcessorEnablerAdminSession: a session to create and delete broker processor enablers
  • BrokerProcessorEnablerNotificationSession: a session to receive notifications pertaining to broker processor enabler changes
  • BrokerProcessorEnablerDistributorSession : a session to look up broker processor enabler distributor mappings
  • BrokerProcessorEnablerDistributorAssignmentSession : a session to manage broker processor enabler to distributor mappings
  • BrokerProcessorEnablerSmartDistributorSession : a session to manage dynamic distributors of broker processor enablers
  • BrokerProcessorEnablerRuleLookupSession: a session to look up broker processor enablers to broker processor mappings
  • BrokerProcessorEnablerRuleApplicationSession: a session to apply broker processor enablers to broker processors
  • QueueEnablerLookupSession: a session to retrieve queue enablers
  • QueueEnablerQuerySession: a session to query for queue enablers
  • QueueEnablerSearchSession: a session to search for queue enablers
  • QueueEnablerAdminSession: a session to create and delete queue enablers
  • QueueEnablerNotificationSession: a session to receive notifications pertaining to queue enabler changes
  • QueueEnablerDistributorSession: a session to look up queue enabler distributor mappings
  • QueueEnablerDistributorAssignmentSession : a session to manage queue enabler to distributor mappings
  • QueueEnablerSmartDistributorSession: a session to manage dynamic distributors of queue enablers
  • QueueEnablerRuleLookupSession: a session to look up queue enablers to queue mappings
  • QueueEnablerRuleApplicationSession: a session to apply queue enablers to queues
  • QueueConstrainerLookupSession: a session to retrieve queue constrainer
  • QueueConstrainerQuerySession: a session to query for queue constrainer
  • QueueConstrainerSearchSession: a session to search for queue constrainer
  • QueueConstrainerAdminSession: a session to create and delete queue constrainer
  • QueueConstrainerNotificationSession: a session to receive notifications pertaining to queue constrainer changes
  • QueueConstrainerDistributorSession: a session to look up queue constrainer distributor mappings
  • QueueConstrainerDistributorAssignmentSession: a session to manage queue constrainer to distributor mappings
  • QueueConstrainerSmartDistributorSession: a session to manage dynamic distributors of queue constrainer
  • QueueConstrainerRuleLookupSession: a session to look up queue constrainer to queue mappings
  • QueueConstrainerRuleApplicationSession: a session to apply queue constrainer to queues
  • QueueConstrainerEnablerLookupSession: a session to retrieve queue constrainer enablers
  • QueueConstrainerEnablerQuerySession: a session to query for queue constrainer enablers
  • QueueConstrainerEnablerSearchSession: a session to search for queue constrainer enablers
  • QueueConstrainerEnablerAdminSession: a session to create and delete queue constrainer enablers
  • QueueConstrainerEnablerNotificationSession: a session to receive notifications pertaining to queue constrainer enabler changes
  • QueueConstrainerEnablerDistributorSession: a session to look up queue constrainer enabler distributor mappings
  • QueueConstrainerEnablerDistributorAssignmentSession : a session to manage queue constrainer enabler to distributor mappings
  • QueueConstrainerEnablerSmartDistributorSession : a session to manage dynamic distributors of queue constrainer enablers
  • QueueConstrainerEnableRuleLookupSession: a session to look up queue constrainer enabler mappings
  • QueueConstrainerEnablerRuleApplicationSession : a session to apply queue constrainer enablers
  • QueueProcessorLookupSession: a session to retrieve queue processor
  • QueueProcessorQuerySession: a session to query for queue processor
  • QueueProcessorSearchSession: a session to search for queue processor
  • QueueProcessorAdminSession: a session to create and delete queue processor
  • QueueProcessorNotificationSession: a session to receive notifications pertaining to queue processor changes
  • QueueProcessorDistributorSession: a session to look up queue processor distributor mappings
  • QueueProcessorDistributorAssignmentSession: a session to manage queue processor to distributor mappings
  • QueueProcessorSmartDistributorSession: a session to manage dynamic distributors of queue processor
  • QueueProcessorRuleLookupSession: a session to look up queue processor to queue mappings
  • QueueProcessorRuleApplicationSession: a session to apply queue processor to queues
  • QueueProcessorEnablerLookupSession: a session to retrieve queue processor enablers
  • QueueProcessorEnablerQuerySession: a session to query for queue processor enablers
  • QueueProcessorEnablerSearchSession: a session to search for queue processor enablers
  • QueueProcessorEnablerAdminSession: a session to create and delete queue processor enablers
  • QueueProcessorEnablerNotificationSession : a session to receive notifications pertaining to queue processor enabler changes
  • QueueProcessorEnablerDistributorSession: a session to look up queue processor enabler distributor mappings
  • QueueProcessorEnablerDistributorAssignmentSession : a session to manage queue processor enabler to distributor mappings
  • QueueProcessorEnablerSmartDistributorSession: a session to manage dynamic distributors of queue processor enablers
  • QueueProcessorEnablerRuleLookupSession: a session to look up queue processor enabler mappings
  • QueueProcessorEnablerRuleApplicationSession: a session to apply queue processor enablers
  • PoolEnablerLookupSession: a session to retrieve pool enablers
  • PoolEnablerQuerySession: a session to query for pool enablers
  • PoolEnablerSearchSession: a session to search for pool enablers
  • PoolEnablerAdminSession: a session to create and delete pool enablers
  • PoolEnablerNotificationSession: a session to receive notifications pertaining to pool enabler changes
  • PoolEnablerDistributorSession: a session to look up pool enabler distributor mappings
  • PoolEnablerDistributorAssignmentSession: a session to manage pool enabler to distributor mappings
  • PoolEnablerSmartDistributorSession: a session to manage dynamic distributors of pool enablers
  • PoolEnablerRuleLookupSession: a session to look up pool enablers to pool mappings
  • PoolEnablerRuleApplicationSession: a session to apply pool enablers to pools
  • PoolConstrainerLookupSession: a session to retrieve pool constrainer
  • PoolConstrainerQuerySession: a session to query for pool constrainer
  • PoolConstrainerSearchSession: a session to search for pool constrainer
  • PoolConstrainerAdminSession: a session to create and delete pool constrainer
  • PoolConstrainerNotificationSession: a session to receive notifications pertaining to pool constrainer changes
  • PoolConstrainerDistributorSession: a session to look up pool constrainer distributor mappings
  • PoolConstrainerDistributorAssignmentSession: a session to manage pool constrainer to distributor mappings
  • PoolConstrainerSmartDistributorSession: a session to manage dynamic distributors of pool constrainer
  • PoolConstrainerRuleLookupSession: a session to look up pool constrainer to pool mappings
  • PoolConstrainerRuleApplicationSession: a session to apply pool constrainer to pools
  • PoolConstrainerEnablerLookupSession: a session to retrieve pool constrainer enablers
  • PoolConstrainerEnablerQuerySession: a session to query for pool constrainer enablers
  • PoolConstrainerEnablerSearchSession: a session to search for pool constrainer enablers
  • PoolConstrainerEnablerAdminSession: a session to create and delete pool constrainer enablers
  • PoolConstrainerEnablerNotificationSession: a session to receive notifications pertaining to pool constrainer enabler changes
  • PoolConstrainerEnablerDistributorSession : a session to look up pool constrainer enabler distributor mappings
  • PoolConstrainerEnablerDistributorAssignmentSession : a session to manage pool constrainer enabler to distributor mappings
  • PoolConstrainerEnablerSmartDistributorSession : a session to manage dynamic distributors of pool constrainer enablers
  • PoolConstrainerEnableRuleLookupSession: a session to look up pool constrainer enabler mappings
  • PoolConstrainerEnablerRuleApplicationSession: a session to apply pool constrainer enablers
  • PoolProcessorLookupSession: a session to retrieve pool processor
  • PoolProcessorQuerySession: a session to query for pool processor
  • PoolProcessorSearchSession: a session to search for pool processor
  • PoolProcessorAdminSession: a session to create and delete pool processor
  • PoolProcessorNotificationSession: a session to receive notifications pertaining to pool processor changes
  • PoolProcessorDistributorSession: a session to look up pool processor distributor mappings
  • PoolProcessorDistributorAssignmentSession: a session to manage pool processor to distributor mappings
  • PoolProcessorSmartDistributorSession: a session to manage dynamic distributors of pool processor
  • PoolProcessorRuleLookupSession: a session to look up pool processor to pool mappings
  • PoolProcessorRuleApplicationSession: a session to apply pool processor to pools
  • PoolProcessorEnablerLookupSession: a session to retrieve pool processor enablers
  • PoolProcessorEnablerQuerySession: a session to query for pool processor enablers
  • PoolProcessorEnablerSearchSession: a session to search for pool processor enablers
  • PoolProcessorEnablerAdminSession: a session to create and delete pool processor enablers
  • PoolProcessorEnablerNotificationSession: a session to receive notifications pertaining to pool processor enabler changes
  • PoolProcessorEnablerDistributorSession: a session to look up pool processor enabler distributor mappings
  • PoolProcessorEnablerDistributorAssignmentSession : a session to manage pool processor enabler to distributor mappings
  • PoolProcessorEnablerSmartDistributorSession: a session to manage dynamic distributors of pool processor enablers
  • PoolProcessorEnablerRuleLookupSession: a session to look up pool processor enabler mappings
  • PoolProcessorEnablerRuleApplicationSession: a session to apply pool processor enablers
  • ProvisionEnablerLookupSession: a session to retrieve provision enablers
  • ProvisionEnablerQuerySession: a session to query for provision enablers
  • ProvisionEnablerSearchSession: a session to search for provision enablers
  • ProvisionEnablerAdminSession: a session to create and delete provision enablers
  • ProvisionEnablerNotificationSession: a session to receive notifications pertaining to provision enabler changes
  • ProvisionEnablerDistributorSession: a session to look up provision enabler distributor mappings
  • ProvisionEnablerDistributorAssignmentSession: a session to manage provision enabler to distributor mappings
  • ProvisionEnablerSmartDistributorSession: a session to manage dynamic distributors of provision enablers
  • ProvisionEnablerRuleLookupSession: a session to look up provision enablers to provision mappings
  • ProvisionEnablerRuleApplicationSession: a session to apply provision enablers to provisions
  • ProvisionEnablerLookupSession: a session to retrieve provision enablers
  • ProvisionEnablerQuerySession: a session to query for provision enablers
  • ProvisionEnablerSearchSession: a session to search for provision enablers
  • ProvisionEnablerAdminSession: a session to create and delete provision enablers
  • ProvisionEnablerNotificationSession: a session to receive notifications pertaining to provision enabler changes
  • ProvisionEnablerDistributorSession: a session to look up provision enabler distributor mappings
  • ProvisionEnablerDistributorAssignmentSession: a session to manage provision enabler to distributor mappings
  • ProvisionEnablerSmartDistributorSession: a session to manage dynamic distributors of provision enablers
  • ProvisionEnablerRuleLookupSession: a session to look up provision enablers to provision mappings
  • ProvisionEnablerRuleApplicationSession: a session to apply provision enablers to provisions
MethodgetBrokerEnablerLookupSession
Description

Gets the OsidSession associated with the broker enabler lookup service.

Returnosid.provisioning.rules.BrokerEnablerLookupSession a BrokerEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerLookup() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerLookup() is true.
MethodgetBrokerEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker enabler query service.

Returnosid.provisioning.rules.BrokerEnablerQuerySession a BrokerEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerQuery() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerQuery() is true.
MethodgetBrokerEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker enabler search service.

Returnosid.provisioning.rules.BrokerEnablerSearchSession a BrokerEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerSearch() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerSearch() is true.
MethodgetBrokerEnablerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker enabler administration service.

Returnosid.provisioning.rules.BrokerEnablerAdminSession a BrokerEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerAdmin() is true.
MethodgetBrokerEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker enabler notification service.

Parametersosid.provisioning.rules.BrokerEnablerReceiverbrokerEnablerReceiver the notification callback
Returnosid.provisioning.rules.BrokerEnablerNotificationSession a BrokerEnablerNotificationSession
ErrorsNULL_ARGUMENT brokerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerNotification() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerNotification() is true.
MethodgetBrokerEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup broker enabler/distributor mappings.

Returnosid.provisioning.rules.BrokerEnablerDistributorSession a BrokerEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerDistributor() is true.
MethodgetBrokerEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker enablers to distributors.

Returnosid.provisioning.rules.BrokerEnablerDistributorAssignmentSession a BrokerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerDistributorAssignment() is true .
MethodgetBrokerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage broker enabler smart distributors.

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

Gets the OsidSession associated with the broker enabler broker mapping lookup service for looking up the rules applied to a broker.

Returnosid.provisioning.rules.BrokerEnablerRuleLookupSession a BrokerEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerRuleLookup() is true.
MethodgetBrokerEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the broker enabler mapping lookup service for the given distributor for looking up rules applied to a broker.

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

Gets the OsidSession associated with the broker constrainer assignment service to apply to brokers.

Returnosid.provisioning.rules.BrokerEnablerRuleApplicationSession a BrokerEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsBrokerEnablerRuleApplication() is true.
MethodgetBrokerEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the broker enabler assignment service for the given distributor to apply to brokers.

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

Gets the OsidSession associated with the broker constrainer lookup service.

Returnosid.provisioning.rules.BrokerConstrainerLookupSession a BrokerConstrainerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerLookup() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerLookup() is true.
MethodgetBrokerConstrainerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer query service.

Returnosid.provisioning.rules.BrokerConstrainerQuerySession a BrokerConstrainerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerQuery() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerQuery() is true.
MethodgetBrokerConstrainerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer search service.

Returnosid.provisioning.rules.BrokerConstrainerSearchSession a BrokerConstrainerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerSearch() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerSearch() is true.
MethodgetBrokerConstrainerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer administration service.

Returnosid.provisioning.rules.BrokerConstrainerAdminSession a BrokerConstrainerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerAdmin() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerAdmin() is true.
MethodgetBrokerConstrainerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer notification service.

Parametersosid.provisioning.rules.BrokerConstrainerReceiverbrokerConstrainerReceiver the notification callback
Returnosid.provisioning.rules.BrokerConstrainerNotificationSession a BrokerConstrainerNotificationSession
ErrorsNULL_ARGUMENT brokerConstrainerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerNotification() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerNotification() is true.
MethodgetBrokerConstrainerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup broker constrainer/distributor mappings.

Returnosid.provisioning.rules.BrokerConstrainerDistributorSession a BrokerConstrainerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerDistributor() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerDistributor() is true.
MethodgetBrokerConstrainerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker constrainers to distributors.

Returnosid.provisioning.rules.BrokerConstrainerDistributorAssignmentSession a BrokerConstrainerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerDistributorAssignment() is true.
MethodgetBrokerConstrainerSmartDistributorSession
Description

Gets the OsidSession to manage broker constrainer smart distributors.

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

Gets the OsidSession associated with the broker constrainer broker mapping lookup service for looking up the rules applied to a broker.

Returnosid.provisioning.rules.BrokerConstrainerRuleLookupSession a BrokerConstrainerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerRuleLookup() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerRuleLookup() is true.
MethodgetBrokerConstrainerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the broker constrainer mapping lookup service for the given distributor for looking up rules applied to a broker.

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

Gets the OsidSession associated with the broker constrainer assignment service to apply to brokers.

Returnosid.provisioning.rules.BrokerConstrainerRuleApplicationSession a BrokerConstrainerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerRuleApplication() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerRuleApplication() is true.
MethodgetBrokerConstrainerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the broker constrainer assignment service for the given distributor to apply to brokers.

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

Gets the OsidSession associated with the broker constrainer enabler lookup service.

Returnosid.provisioning.rules.BrokerConstrainerEnablerLookupSession a BrokerConstrainerEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerLookup() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerLookup() is true.
MethodgetBrokerConstrainerEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer enabler query service.

Returnosid.provisioning.rules.BrokerConstrainerEnablerQuerySession a BrokerConstrainerEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerQuery() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerQuery() is true.
MethodgetBrokerConstrainerEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer enabler search service.

Returnosid.provisioning.rules.BrokerConstrainerEnablerSearchSession a BrokerConstrainerEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerSearch() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerSearch() is true.
MethodgetBrokerConstrainerEnablerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer enabler administration service.

Returnosid.provisioning.rules.BrokerConstrainerEnablerAdminSession a BrokerConstrainerEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerAdmin() is true.
MethodgetBrokerConstrainerEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker constrainer enabler notification service.

Parametersosid.provisioning.rules.BrokerConstrainerEnablerReceiverbrokerConstrainerEnablerReceiver the notification callback
Returnosid.provisioning.rules.BrokerConstrainerEnablerNotificationSession a BrokerConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT brokerConstrainerEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerNotification() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerNotification() is true.
MethodgetBrokerConstrainerEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup broker constrainer enabler/distributor mappings.

Returnosid.provisioning.rules.BrokerConstrainerEnablerDistributorSession a BrokerConstrainerEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerDistributor() is true.
MethodgetBrokerConstrainerEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker constrainer enablers to distributors.

Returnosid.provisioning.rules.BrokerConstrainerEnablerDistributorAssignmentSession a BrokerConstrainerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerDistributorAssignment() is true.
MethodgetBrokerConstrainerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage broker constrainer enabler smart distributors.

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

Gets the OsidSession associated with the broker constrainer enabler broker mapping lookup service for looking up the rules applied to a broker constrainer.

Returnosid.provisioning.rules.BrokerConstrainerEnablerRuleLookupSession a BrokerConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerRuleLookup() is true .
MethodgetBrokerConstrainerEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the broker constrainer enabler mapping lookup service for the given distributor for looking up rules applied to a broker constrainer.

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

Gets the OsidSession associated with the broker constrainer enabler assignment service to apply to broker constrainers.

Returnosid.provisioning.rules.BrokerConstrainerEnablerRuleApplicationSession a BrokerConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsBrokerConstrainerEnablerRuleApplication() is true.
MethodgetBrokerConstrainerEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the broker constrainer enabler assignment service for the given distributor to apply to broker constrainers.

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

Gets the OsidSession associated with the broker processor lookup service.

Returnosid.provisioning.rules.BrokerProcessorLookupSession a BrokerProcessorLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorLookup() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorLookup() is true.
MethodgetBrokerProcessorLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor query service.

Returnosid.provisioning.rules.BrokerProcessorQuerySession a BrokerProcessorQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorQuery() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorQuery() is true.
MethodgetBrokerProcessorQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor search service.

Returnosid.provisioning.rules.BrokerProcessorSearchSession a BrokerProcessorSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorSearch() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorSearch() is true.
MethodgetBrokerProcessorSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor administration service.

Returnosid.provisioning.rules.BrokerProcessorAdminSession a BrokerProcessorAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorAdmin() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorAdmin() is true.
MethodgetBrokerProcessorAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor notification service.

Parametersosid.provisioning.rules.BrokerProcessorReceiverbrokerProcessorReceiver the notification callback
Returnosid.provisioning.rules.BrokerProcessorNotificationSession a BrokerProcessorNotificationSession
ErrorsNULL_ARGUMENT brokerConstrainerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorNotification() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorNotification() is true.
MethodgetBrokerProcessorNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup broker processor/distributor mappings.

Returnosid.provisioning.rules.BrokerProcessorDistributorSession a BrokerProcessorDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorDistributor() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorDistributor() is true.
MethodgetBrokerProcessorDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker processors to distributors.

Returnosid.provisioning.rules.BrokerProcessorDistributorAssignmentSession a BrokerProcessorDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorDistributorAssignment() is true.
MethodgetBrokerProcessorSmartDistributorSession
Description

Gets the OsidSession to manage broker processor smart distributors.

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

Gets the OsidSession associated with the broker processor broker mapping lookup service for looking up the rules applied to a broker.

Returnosid.provisioning.rules.BrokerProcessorRuleLookupSession a BrokerProcessorRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorRuleLookup() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorRuleLookup() is true.
MethodgetBrokerProcessorRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the broker processor mapping lookup service for the given distributor for looking up rules applied to a brokers.

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

Gets the OsidSession associated with the broker processor assignment service to apply to brokers.

Returnosid.provisioning.rules.BrokerProcessorRuleApplicationSession a BrokerProcessorRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorRuleApplication() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorRuleApplication() is true.
MethodgetBrokerProcessorRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the broker processor assignment service for the given distributor to apply to brokers.

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

Gets the OsidSession associated with the broker processor enabler lookup service.

Returnosid.provisioning.rules.BrokerProcessorEnablerLookupSession a BrokerProcessorEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerLookup() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerLookup() is true.
MethodgetBrokerProcessorEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor enabler query service.

Returnosid.provisioning.rules.BrokerProcessorEnablerQuerySession a BrokerProcessorEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerQuery() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerQuery() is true.
MethodgetBrokerProcessorEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor enabler search service.

Returnosid.provisioning.rules.BrokerProcessorEnablerSearchSession a BrokerProcessorEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerSearch() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerSearch() is true.
MethodgetBrokerProcessorEnablerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor enabler administration service.

Returnosid.provisioning.rules.BrokerProcessorEnablerAdminSession a BrokerProcessorEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerAdmin() is true.
MethodgetBrokerProcessorEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the broker processor enabler notification service.

Parametersosid.provisioning.rules.BrokerProcessorEnablerReceiverbrokerProcessorEnablerReceiver the notification callback
Returnosid.provisioning.rules.BrokerProcessorEnablerNotificationSession a BrokerProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT brokerProcessorEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerNotification() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerNotification() is true .
MethodgetBrokerProcessorEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup broker processor enabler/distributor mappings.

Returnosid.provisioning.rules.BrokerProcessorEnablerDistributorSession a BrokerProcessorEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerDistributor() is true.
MethodgetBrokerProcessorEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker processors enablers to distributors.

Returnosid.provisioning.rules.BrokerProcessorEnablerDistributorAssignmentSession a BrokerProcessorEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerDistributorAssignment() is true.
MethodgetBrokerProcessorEnablerSmartDistributorSession
Description

Gets the OsidSession to manage broker processor enabler smart distributors.

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

Gets the OsidSession associated with the broker processor enabler broker mapping lookup service for looking up the rules applied to a broker processor.

Returnosid.provisioning.rules.BrokerProcessorEnablerRuleLookupSession a BrokerProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerRuleLookup() is true.
MethodgetBrokerProcessorEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the broker processor enabler mapping lookup service for the given distributor for looking up rules applied to a broker processors.

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

Gets the OsidSession associated with the broker processor enabler assignment service to apply to broker processors.

Returnosid.provisioning.rules.BrokerProcessorEnablerRuleApplicationSession a BrokerProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsBrokerProcessorEnablerRuleApplication() is true.
MethodgetBrokerProcessorEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the broker processor enabler assignment service for the given distributor to apply to broker processors.

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

Gets the OsidSession associated with the queue enabler lookup service.

Returnosid.provisioning.rules.QueueEnablerLookupSession a QueueEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerLookup() is false
Complianceoptional This method must be implemented if supportsQueueEnablerLookup() is true.
MethodgetQueueEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue enabler query service.

Returnosid.provisioning.rules.QueueEnablerQuerySession a QueueEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerQuery() is false
Complianceoptional This method must be implemented if supportsQueueEnablerQuery() is true.
MethodgetQueueEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue enabler search service.

Returnosid.provisioning.rules.QueueEnablerSearchSession a QueueEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerSearch() is false
Complianceoptional This method must be implemented if supportsQueueEnablerSearch() is true.
MethodgetQueueEnablerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue enabler administration service.

Returnosid.provisioning.rules.QueueEnablerAdminSession a QueueEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsQueueEnablerAdmin() is true.
MethodgetQueueEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue enabler notification service.

Parametersosid.provisioning.rules.QueueEnablerReceiverqueueEnablerReceiver the notification callback
Returnosid.provisioning.rules.QueueEnablerNotificationSession a QueueEnablerNotificationSession
ErrorsNULL_ARGUMENT queueReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerNotification() is false
Complianceoptional This method must be implemented if supportsQueueEnablerNotification() is true.
MethodgetQueueEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup queue enabler/distributor mappings.

Returnosid.provisioning.rules.QueueEnablerDistributorSession a QueueEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsQueueEnablerDistributor() is true.
MethodgetQueueEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue enablers to distributors.

Returnosid.provisioning.rules.QueueEnablerDistributorAssignmentSession a QueueEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsQueueEnablerDistributorAssignment() is true.
MethodgetQueueEnablerSmartDistributorSession
Description

Gets the OsidSession to manage queue enabler smart distributors.

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

Gets the OsidSession associated with the queue enabler queue mapping lookup service for looking up the rules applied to a queue.

Returnosid.provisioning.rules.QueueEnablerRuleLookupSession a QueueEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsQueueEnablerRuleLookup() is true.
MethodgetQueueEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the queue enabler mapping lookup service for the given distributor for looking up rules applied to a queue.

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

Gets the OsidSession associated with the queue constrainer assignment service to apply to queues.

Returnosid.provisioning.rules.QueueEnablerRuleApplicationSession a QueueEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsQueueEnablerRuleApplication() is true.
MethodgetQueueEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the queue enabler assignment service for the given distributor to apply to queues.

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

Gets the OsidSession associated with the queue constrainer lookup service.

Returnosid.provisioning.rules.QueueConstrainerLookupSession a QueueConstrainerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerLookup() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerLookup() is true.
MethodgetQueueConstrainerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue constrainer query service.

Returnosid.provisioning.rules.QueueConstrainerQuerySession a QueueConstrainerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerQuery() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerQuery() is true.
MethodgetQueueConstrainerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue constrainer search service.

Returnosid.provisioning.rules.QueueConstrainerSearchSession a QueueConstrainerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerSearch() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerSearch() is true.
MethodgetQueueConstrainerSearchSessionForDistributor
Description

Gets the OsidSession associated with the queue constrainer earch service for the given distributor.

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

Gets the OsidSession associated with the queue constrainer administration service.

Returnosid.provisioning.rules.QueueConstrainerAdminSession a QueueConstrainerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerAdmin() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerAdmin() is true.
MethodgetQueueConstrainerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue constrainer notification service.

Parametersosid.provisioning.rules.QueueConstrainerReceiverqueueConstrainerReceiver the notification callback
Returnosid.provisioning.rules.QueueConstrainerNotificationSession a QueueConstrainerNotificationSession
ErrorsNULL_ARGUMENT queueConstrainerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerNotification() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerNotification() is true.
MethodgetQueueConstrainerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup queue constrainer/distributor mappings for queue constrainers.

Returnosid.provisioning.rules.QueueConstrainerDistributorSession a QueueConstrainerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerDistributor() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerDistributor() is true.
MethodgetQueueConstrainerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue constrainer to distributors.

Returnosid.provisioning.rules.QueueConstrainerDistributorAssignmentSession a QueueConstrainerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerDistributorAssignment() is true.
MethodgetQueueConstrainerSmartDistributorSession
Description

Gets the OsidSession to manage queue constrainer smart distributors.

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

Gets the OsidSession associated with the queue constrainer mapping lookup service for looking up the rules applied to a queue.

Returnosid.provisioning.rules.QueueConstrainerRuleLookupSession a QueueConstrainerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleLookup() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerRuleLookup() is true.
MethodgetQueueConstrainerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the queue constrainer mapping lookup service for the given distributor for looking up rules applied to a queue.

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

Gets the OsidSession associated with the queue constrainer assignment service to apply to queues.

Returnosid.provisioning.rules.QueueConstrainerRuleApplicationSession a QueueConstrainerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleApplication() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerRuleApplication() is true.
MethodgetQueueConstrainerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the queue constrainer assignment service for the given distributor to apply to queues.

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

Gets the OsidSession associated with the queue constrainer enabler lookup service.

Returnosid.provisioning.rules.QueueConstrainerEnablerLookupSession a QueueConstrainerEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerLookup() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerLookup() is true.
MethodgetQueueConstrainerEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue constrainer enabler query service.

Returnosid.provisioning.rules.QueueConstrainerEnablerQuerySession a QueueConstrainerEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerQuery() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerQuery() is true.
MethodgetQueueConstrainerEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue constrainer enabler search service.

Returnosid.provisioning.rules.QueueConstrainerEnablerSearchSession a QueueConstrainerEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerSearch() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerSearch() is true.
MethodgetQueueConstrainerEnablerSearchSessionForDistributor
Description

Gets the OsidSession associated with the queue constrainer enablers earch service for the given distributor.

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

Gets the OsidSession associated with the queue constrainer enabler administration service.

Returnosid.provisioning.rules.QueueConstrainerEnablerAdminSession a QueueConstrainerEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerAdmin() is true.
MethodgetQueueConstrainerEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue constrainer enabler notification service.

Parametersosid.provisioning.rules.QueueConstrainerEnablerReceiverqueueConstrainerEnablerReceiver the notification callback
Returnosid.provisioning.rules.QueueConstrainerEnablerNotificationSession a QueueConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT queueConstrainerEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerNotification() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerNotification() is true.
MethodgetQueueConstrainerEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup queue constrainer enabler/distributor mappings for queue constrainer enablers.

Returnosid.provisioning.rules.QueueConstrainerEnablerDistributorSession a QueueConstrainerEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerDistributor() is true .
MethodgetQueueConstrainerEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue constrainer enablers to distributors.

Returnosid.provisioning.rules.QueueConstrainerEnablerDistributorAssignmentSession a QueueConstrainerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerDistributorAssignment() is true.
MethodgetQueueConstrainerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage queue constrainer enabler smart distributors.

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

Gets the OsidSession associated with the queue constrainer enabler mapping lookup service.

Returnosid.provisioning.rules.QueueConstrainerEnablerRuleLookupSession a QueueConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerRuleLookup() is true.
MethodgetQueueConstrainerEnablerRuleLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue constrainer enabler assignment service.

Returnosid.provisioning.rules.QueueConstrainerEnablerRuleApplicationSession a QueueConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsQueueConstrainerEnablerRuleApplication() is true.
MethodgetQueueConstrainerEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the queue constrainer enabler assignment service for the given distributor.

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

Gets the OsidSession associated with the queue processor lookup service.

Returnosid.provisioning.rules.QueueProcessorLookupSession a QueueProcessorLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorLookup() is false
Complianceoptional This method must be implemented if supportsQueueProcessorLookup() is true.
MethodgetQueueProcessorLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue processor query service.

Returnosid.provisioning.rules.QueueProcessorQuerySession a QueueProcessorQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorQuery() is false
Complianceoptional This method must be implemented if supportsQueueProcessorQuery() is true.
MethodgetQueueProcessorQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue processor search service.

Returnosid.provisioning.rules.QueueProcessorSearchSession a QueueProcessorSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorSearch() is false
Complianceoptional This method must be implemented if supportsQueueProcessorSearch() is true.
MethodgetQueueProcessorSearchSessionForDistributor
Description

Gets the OsidSession associated with the queue processor earch service for the given distributor.

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

Gets the OsidSession associated with the queue processor administration service.

Returnosid.provisioning.rules.QueueProcessorAdminSession a QueueProcessorAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorAdmin() is false
Complianceoptional This method must be implemented if supportsQueueProcessorAdmin() is true.
MethodgetQueueProcessorAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue processor notification service.

Parametersosid.provisioning.rules.QueueProcessorReceiverqueueProcessorReceiver the notification callback
Returnosid.provisioning.rules.QueueProcessorNotificationSession a QueueProcessorNotificationSession
ErrorsNULL_ARGUMENT queueProcessorReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorNotification() is false
Complianceoptional This method must be implemented if supportsQueueProcessorNotification() is true.
MethodgetQueueProcessorNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup queue processor/distributor mappings for queue processors.

Returnosid.provisioning.rules.QueueProcessorDistributorSession a QueueProcessorDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorDistributor() is false
Complianceoptional This method must be implemented if supportsQueueProcessorDistributor() is true.
MethodgetQueueProcessorDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue processor to distributors.

Returnosid.provisioning.rules.QueueProcessorDistributorAssignmentSession a QueueProcessorDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsQueueProcessorDistributorAssignment() is true.
MethodgetQueueProcessorSmartDistributorSession
Description

Gets the OsidSession to manage queue processor smart distributors.

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

Gets the OsidSession associated with the queue processor mapping lookup service for looking up the rules applied to a queue.

Returnosid.provisioning.rules.QueueProcessorRuleLookupSession a QueueProcessorRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleLookup() is false
Complianceoptional This method must be implemented if supportsQueueProcessorRuleLookup() is true.
MethodgetQueueProcessorRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the queue processor mapping lookup service for the given distributor for looking up rules applied to a queue.

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

Gets the OsidSession associated with the queue processor assignment service.

Returnosid.provisioning.rules.QueueProcessorRuleApplicationSession a QueueProcessorRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleApplication() is false
Complianceoptional This method must be implemented if supportsQueueProcessorRuleApplication() is true.
MethodgetQueueProcessorRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the queue processor assignment service for the given distributor.

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

Gets the OsidSession associated with the queue processor enabler lookup service.

Returnosid.provisioning.rules.QueueProcessorEnablerLookupSession a QueueProcessorEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerLookup() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerLookup() is true.
MethodgetQueueProcessorEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue processor enabler query service.

Returnosid.provisioning.rules.QueueProcessorEnablerQuerySession a QueueProcessorEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerQuery() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerQuery() is true.
MethodgetQueueProcessorEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue processor enabler search service.

Returnosid.provisioning.rules.QueueProcessorEnablerSearchSession a QueueProcessorEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerSearch() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerSearch() is true.
MethodgetQueueProcessorEnablerSearchSessionForDistributor
Description

Gets the OsidSession associated with the queue processor enablers earch service for the given distributor.

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

Gets the OsidSession associated with the queue processor enabler administration service.

Returnosid.provisioning.rules.QueueProcessorEnablerAdminSession a QueueProcessorEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerAdmin() is true.
MethodgetQueueProcessorEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the queue processor enabler notification service.

Parametersosid.provisioning.rules.QueueProcessorEnablerReceiverqueueProcessorEnablerReceiver the notification callback
Returnosid.provisioning.rules.QueueProcessorEnablerNotificationSession a QueueProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT queueProcessorEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerNotification() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerNotification() is true.
MethodgetQueueProcessorEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup queue processor enabler/distributor mappings for queue processor enablers.

Returnosid.provisioning.rules.QueueProcessorEnablerDistributorSession a QueueProcessorEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerDistributor() is true.
MethodgetQueueProcessorEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue processor enablers to distributors.

Returnosid.provisioning.rules.QueueProcessorEnablerDistributorAssignmentSession a QueueProcessorEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerDistributorAssignment() is true.
MethodgetQueueProcessorEnablerSmartDistributorSession
Description

Gets the OsidSession to manage queue processor enabler smart distributors.

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

Gets the OsidSession associated with the queue processor enabler mapping lookup service.

Returnosid.provisioning.rules.QueueProcessorEnablerRuleLookupSession a QueueProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerRuleLookup() is true.
MethodgetQueueProcessorEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the queue processor enabler mapping lookup service.

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

Gets the OsidSession associated with the queue processor enabler assignment service.

Returnosid.provisioning.rules.QueueProcessorEnablerRuleApplicationSession a QueueProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsQueueProcessorEnablerRuleApplication() is true.
MethodgetQueueProcessorEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the queue processor enabler assignment service for the given distributor.

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

Gets the OsidSession associated with the pool enabler lookup service.

Returnosid.provisioning.rules.PoolEnablerLookupSession a PoolEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerLookup() is false
Complianceoptional This method must be implemented if supportsPoolEnablerLookup() is true.
MethodgetPoolEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool enabler query service.

Returnosid.provisioning.rules.PoolEnablerQuerySession a PoolEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerQuery() is false
Complianceoptional This method must be implemented if supportsPoolEnablerQuery() is true.
MethodgetPoolEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool enabler search service.

Returnosid.provisioning.rules.PoolEnablerSearchSession a PoolEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerSearch() is false
Complianceoptional This method must be implemented if supportsPoolEnablerSearch() is true.
MethodgetPoolEnablerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool enabler administration service.

Returnosid.provisioning.rules.PoolEnablerAdminSession a PoolEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsPoolEnablerAdmin() is true.
MethodgetPoolEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool enabler notification service.

Parametersosid.provisioning.rules.PoolEnablerReceiverpoolEnablerReceiver the notification callback
Returnosid.provisioning.rules.PoolEnablerNotificationSession a PoolEnablerNotificationSession
ErrorsNULL_ARGUMENT poolReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerNotification() is false
Complianceoptional This method must be implemented if supportsPoolEnablerNotification() is true.
MethodgetPoolEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup pool enabler/distributor mappings.

Returnosid.provisioning.rules.PoolEnablerDistributorSession a PoolEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsPoolEnablerDistributor() is true.
MethodgetPoolEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool enablers to distributors.

Returnosid.provisioning.rules.PoolEnablerDistributorAssignmentSession a PoolEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsPoolEnablerDistributorAssignment() is true.
MethodgetPoolEnablerSmartDistributorSession
Description

Gets the OsidSession to manage pool enabler smart distributors.

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

Gets the OsidSession associated with the pool enabler pool mapping lookup service for looking up the rules applied to a pool.

Returnosid.provisioning.rules.PoolEnablerRuleLookupSession a PoolEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsPoolEnablerRuleLookup() is true.
MethodgetPoolEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the pool enabler mapping lookup service for the given distributor for looking up rules applied to a pool.

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

Gets the OsidSession associated with the pool constrainer assignment service to apply to pools.

Returnosid.provisioning.rules.PoolEnablerRuleApplicationSession a PoolEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsPoolEnablerRuleApplication() is true.
MethodgetPoolEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the pool enabler assignment service for the given distributor to apply to pools.

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

Gets the OsidSession associated with the pool constrainer lookup service.

Returnosid.provisioning.rules.PoolConstrainerLookupSession a PoolConstrainerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerLookup() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerLookup() is true.
MethodgetPoolConstrainerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool constrainer query service.

Returnosid.provisioning.rules.PoolConstrainerQuerySession a PoolConstrainerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerQuery() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerQuery() is true.
MethodgetPoolConstrainerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool constrainer search service.

Returnosid.provisioning.rules.PoolConstrainerSearchSession a PoolConstrainerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerSearch() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerSearch() is true.
MethodgetPoolConstrainerSearchSessionForDistributor
Description

Gets the OsidSession associated with the pool constrainer earch service for the given distributor.

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

Gets the OsidSession associated with the pool constrainer administration service.

Returnosid.provisioning.rules.PoolConstrainerAdminSession a PoolConstrainerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerAdmin() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerAdmin() is true.
MethodgetPoolConstrainerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool constrainer notification service.

Parametersosid.provisioning.rules.PoolConstrainerReceiverpoolConstrainerReceiver the notification callback
Returnosid.provisioning.rules.PoolConstrainerNotificationSession a PoolConstrainerNotificationSession
ErrorsNULL_ARGUMENT poolConstrainerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerNotification() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerNotification() is true.
MethodgetPoolConstrainerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup pool constrainer/distributor mappings for pool constrainers.

Returnosid.provisioning.rules.PoolConstrainerDistributorSession a PoolConstrainerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerDistributor() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerDistributor() is true.
MethodgetPoolConstrainerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool constrainer to distributors.

Returnosid.provisioning.rules.PoolConstrainerDistributorAssignmentSession a PoolConstrainerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerDistributorAssignment() is true.
MethodgetPoolConstrainerSmartDistributorSession
Description

Gets the OsidSession to manage pool constrainer smart distributors.

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

Gets the OsidSession associated with the pool constrainer mapping lookup service for looking up the rules applied to the pool.

Returnosid.provisioning.rules.PoolConstrainerRuleLookupSession a PoolConstrainerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerRuleLookup() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerRuleLookup() is true.
MethodgetPoolConstrainerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the pool constrainer mapping lookup service for the given distributor for looking up rules applied to a pool.

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

Gets the OsidSession associated with the pool constrainer assignment service to apply to pools.

Returnosid.provisioning.rules.PoolConstrainerRuleApplicationSession a PoolConstrainerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerRuleApplication() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerRuleApplication() is true.
MethodgetPoolConstrainerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the pool constrainer assignment service for the given distributor to apply to pools.

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

Gets the OsidSession associated with the pool constrainer enabler lookup service.

Returnosid.provisioning.rules.PoolConstrainerEnablerLookupSession a PoolConstrainerEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerLookup() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerLookup() is true.
MethodgetPoolConstrainerEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool constrainer enabler query service.

Returnosid.provisioning.rules.PoolConstrainerEnablerQuerySession a PoolConstrainerEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerQuery() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerQuery() is true.
MethodgetPoolConstrainerEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool constrainer enabler search service.

Returnosid.provisioning.rules.PoolConstrainerEnablerSearchSession a PoolConstrainerEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerSearch() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerSearch() is true.
MethodgetPoolConstrainerEnablerSearchSessionForDistributor
Description

Gets the OsidSession associated with the pool constrainer enablers earch service for the given distributor.

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

Gets the OsidSession associated with the pool constrainer enabler administration service.

Returnosid.provisioning.rules.PoolConstrainerEnablerAdminSession a PoolConstrainerEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerAdmin() is true.
MethodgetPoolConstrainerEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool constrainer enabler notification service.

Parametersosid.provisioning.rules.PoolConstrainerEnablerReceiverpoolConstrainerEnablerReceiver the notification callback
Returnosid.provisioning.rules.PoolConstrainerEnablerNotificationSession a PoolConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT poolConstrainerEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerNotification() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerNotification() is true .
MethodgetPoolConstrainerEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup pool constrainer enabler/distributor mappings for pool constrainer enablers.

Returnosid.provisioning.rules.PoolConstrainerEnablerDistributorSession a PoolConstrainerEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerDistributor() is true.
MethodgetPoolConstrainerEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool constrainer enablers to distributors.

Returnosid.provisioning.rules.PoolConstrainerEnablerDistributorAssignmentSession a PoolConstrainerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerDistributorAssignment() is true.
MethodgetPoolConstrainerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage pool constrainer enabler smart distributors.

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

Gets the OsidSession associated with the pool constrainer enabler mapping lookup service.

Returnosid.provisioning.rules.PoolConstrainerEnablerRuleLookupSession a PoolConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerRuleLookup() is true.
MethodgetPoolConstrainerEnablerRuleLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool constrainer enabler assignment service.

Returnosid.provisioning.rules.PoolConstrainerEnablerRuleApplicationSession a PoolConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsPoolConstrainerEnablerRuleApplication() is true.
MethodgetPoolConstrainerEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the pool constrainer enabler assignment service for the given distributor.

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

Gets the OsidSession associated with the pool processor lookup service.

Returnosid.provisioning.rules.PoolProcessorLookupSession a PoolProcessorLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorLookup() is false
Complianceoptional This method must be implemented if supportsPoolProcessorLookup() is true.
MethodgetPoolProcessorLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool processor query service.

Returnosid.provisioning.rules.PoolProcessorQuerySession a PoolProcessorQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorQuery() is false
Complianceoptional This method must be implemented if supportsPoolProcessorQuery() is true.
MethodgetPoolProcessorQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool processor search service.

Returnosid.provisioning.rules.PoolProcessorSearchSession a PoolProcessorSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorSearch() is false
Complianceoptional This method must be implemented if supportsPoolProcessorSearch() is true.
MethodgetPoolProcessorSearchSessionForDistributor
Description

Gets the OsidSession associated with the pool processor earch service for the given distributor.

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

Gets the OsidSession associated with the pool processor administration service.

Returnosid.provisioning.rules.PoolProcessorAdminSession a PoolProcessorAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorAdmin() is false
Complianceoptional This method must be implemented if supportsPoolProcessorAdmin() is true.
MethodgetPoolProcessorAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool processor notification service.

Parametersosid.provisioning.rules.PoolProcessorReceiverpoolProcessorReceiver the notification callback
Returnosid.provisioning.rules.PoolProcessorNotificationSession a PoolProcessorNotificationSession
ErrorsNULL_ARGUMENT poolProcessorReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorNotification() is false
Complianceoptional This method must be implemented if supportsPoolProcessorNotification() is true.
MethodgetPoolProcessorNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup pool processor/distributor mappings for pool processors.

Returnosid.provisioning.rules.PoolProcessorDistributorSession a PoolProcessorDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorDistributor() is false
Complianceoptional This method must be implemented if supportsPoolProcessorDistributor() is true.
MethodgetPoolProcessorDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool processor to distributors.

Returnosid.provisioning.rules.PoolProcessorDistributorAssignmentSession a PoolProcessorDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsPoolProcessorDistributorAssignment() is true .
MethodgetPoolProcessorSmartDistributorSession
Description

Gets the OsidSession to manage pool processor smart distributors.

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

Gets the OsidSession associated with the pool processor mapping lookup service for looking up the rules applied to a pool.

Returnosid.provisioning.rules.PoolProcessorRuleLookupSession a PoolProcessorRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorRuleLookup() is false
Complianceoptional This method must be implemented if supportsPoolProcessorRuleLookup() is true.
MethodgetPoolProcessorRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the pool processor mapping lookup service for the given distributor for looking up rules applied to a pool.

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

Gets the OsidSession associated with the pool processor assignment service.

Returnosid.provisioning.rules.PoolProcessorRuleApplicationSession a PoolProcessorRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorRuleApplication() is false
Complianceoptional This method must be implemented if supportsPoolProcessorRuleApplication() is true.
MethodgetPoolProcessorRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the pool processor assignment service for the given distributor.

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

Gets the OsidSession associated with the pool processor enabler lookup service.

Returnosid.provisioning.rules.PoolProcessorEnablerLookupSession a PoolProcessorEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerLookup() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerLookup() is true.
MethodgetPoolProcessorEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool processor enabler query service.

Returnosid.provisioning.rules.PoolProcessorEnablerQuerySession a PoolProcessorEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerQuery() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerQuery() is true.
MethodgetPoolProcessorEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool processor enabler search service.

Returnosid.provisioning.rules.PoolProcessorEnablerSearchSession a PoolProcessorEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerSearch() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerSearch() is true.
MethodgetPoolProcessorEnablerSearchSessionForDistributor
Description

Gets the OsidSession associated with the pool processor enablers earch service for the given distributor.

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

Gets the OsidSession associated with the pool processor enabler administration service.

Returnosid.provisioning.rules.PoolProcessorEnablerAdminSession a PoolProcessorEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerAdmin() is true.
MethodgetPoolProcessorEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the pool processor enabler notification service.

Parametersosid.provisioning.rules.PoolProcessorEnablerReceiverpoolProcessorEnablerReceiver the notification callback
Returnosid.provisioning.rules.PoolProcessorEnablerNotificationSession a PoolProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT poolProcessorEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerNotification() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerNotification() is true.
MethodgetPoolProcessorEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup pool processor enabler/distributor mappings for pool processor enablers.

Returnosid.provisioning.rules.PoolProcessorEnablerDistributorSession a PoolProcessorEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerDistributor() is true.
MethodgetPoolProcessorEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool processor enablers to distributors.

Returnosid.provisioning.rules.PoolProcessorEnablerDistributorAssignmentSession a PoolProcessorEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerDistributorAssignment() is true.
MethodgetPoolProcessorEnablerSmartDistributorSession
Description

Gets the OsidSession to manage pool processor enabler smart distributors.

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

Gets the OsidSession associated with the pool processor enabler mapping lookup service.

Returnosid.provisioning.rules.PoolProcessorEnablerRuleLookupSession a PoolProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerRuleLookup() is true.
MethodgetPoolProcessorEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the pool processor enabler mapping lookup service.

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

Gets the OsidSession associated with the pool processor enabler assignment service.

Returnosid.provisioning.rules.PoolProcessorEnablerRuleApplicationSession a PoolProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsPoolProcessorEnablerRuleApplication() is true.
MethodgetPoolProcessorEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the pool processor enabler assignment service for the given distributor.

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

Gets the OsidSession associated with the provisionable enabler lookup service.

Returnosid.provisioning.rules.ProvisionableEnablerLookupSession a ProvisionableEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerLookup() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerLookup() is true.
MethodgetProvisionableEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the provisionable enabler query service.

Returnosid.provisioning.rules.ProvisionableEnablerQuerySession a ProvisionableEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerQuery() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerQuery() is true.
MethodgetProvisionableEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the provisionable enabler search service.

Returnosid.provisioning.rules.ProvisionableEnablerSearchSession a ProvisionableEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerSearch() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerSearch() is true.
MethodgetProvisionableEnablerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the provisionable enabler administration service.

Returnosid.provisioning.rules.ProvisionableEnablerAdminSession a ProvisionableEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerAdmin() is true.
MethodgetProvisionableEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the provisionable enabler notification service.

Parametersosid.provisioning.rules.ProvisionableEnablerReceiverprovisionableEnablerReceiver the notification callback
Returnosid.provisioning.rules.ProvisionableEnablerNotificationSession a ProvisionableEnablerNotificationSession
ErrorsNULL_ARGUMENT provisionableReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerNotification() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerNotification() is true.
MethodgetProvisionableEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup provisionable enabler/distributor mappings.

Returnosid.provisioning.rules.ProvisionableEnablerDistributorSession a ProvisionableEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerDistributor() is true.
MethodgetProvisionableEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provisionable enablers to distributors.

Returnosid.provisioning.rules.ProvisionableEnablerDistributorAssignmentSession a ProvisionableEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerDistributorAssignment() is true.
MethodgetProvisionableEnablerSmartDistributorSession
Description

Gets the OsidSession to manage provisionable enabler smart distributors.

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

Gets the OsidSession associated with the provisionable enabler provisionable mapping lookup service for looking up the rules applied to a provisionable.

Returnosid.provisioning.rules.ProvisionableEnablerRuleLookupSession a ProvisionableEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerRuleLookup() is true.
MethodgetProvisionableEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the provisionable enabler mapping lookup service for the given distributor for looking up rules applied to a provisionable.

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

Gets the OsidSession associated with the provisionable constrainer assignment service to apply to provisionables.

Returnosid.provisioning.rules.ProvisionableEnablerRuleApplicationSession a ProvisionableEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionableEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsProvisionableEnablerRuleApplication() is true.
MethodgetProvisionableEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the provisionable enabler assignment service for the given distributor to apply to provisionables.

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

Gets the OsidSession associated with the provision enabler lookup service.

Returnosid.provisioning.rules.ProvisionEnablerLookupSession a ProvisionEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerLookup() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerLookup() is true.
MethodgetProvisionEnablerLookupSessionForDistributor
Description

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

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

Gets the OsidSession associated with the provision enabler query service.

Returnosid.provisioning.rules.ProvisionEnablerQuerySession a ProvisionEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerQuery() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerQuery() is true.
MethodgetProvisionEnablerQuerySessionForDistributor
Description

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

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

Gets the OsidSession associated with the provision enabler search service.

Returnosid.provisioning.rules.ProvisionEnablerSearchSession a ProvisionEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerSearch() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerSearch() is true.
MethodgetProvisionEnablerSearchSessionForDistributor
Description

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

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

Gets the OsidSession associated with the provision enabler administration service.

Returnosid.provisioning.rules.ProvisionEnablerAdminSession a ProvisionEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerAdmin() is true.
MethodgetProvisionEnablerAdminSessionForDistributor
Description

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

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

Gets the OsidSession associated with the provision enabler notification service.

Parametersosid.provisioning.rules.ProvisionEnablerReceiverprovisionEnablerReceiver the notification callback
Returnosid.provisioning.rules.ProvisionEnablerNotificationSession a ProvisionEnablerNotificationSession
ErrorsNULL_ARGUMENT provisionReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerNotification() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerNotification() is true.
MethodgetProvisionEnablerNotificationSessionForDistributor
Description

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

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

Gets the OsidSession to lookup provision enabler/distributor mappings.

Returnosid.provisioning.rules.ProvisionEnablerDistributorSession a ProvisionEnablerDistributorSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerDistributor() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerDistributor() is true.
MethodgetProvisionEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provision enablers to distributors.

Returnosid.provisioning.rules.ProvisionEnablerDistributorAssignmentSession a ProvisionEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerDistributorAssignment() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerDistributorAssignment() is true.
MethodgetProvisionEnablerSmartDistributorSession
Description

Gets the OsidSession to manage provision enabler smart distributors.

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

Gets the OsidSession associated with the provision enabler provision mapping lookup service for looking up the rules applied to a provision.

Returnosid.provisioning.rules.ProvisionEnablerRuleLookupSession a ProvisionEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerRuleLookup() is true.
MethodgetProvisionEnablerRuleLookupSessionForDistributor
Description

Gets the OsidSession associated with the provision enabler mapping lookup service for the given distributor for looking up rules applied to a provision.

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

Gets the OsidSession associated with the provision constrainer assignment service to apply to provision.

Returnosid.provisioning.rules.ProvisionEnablerRuleApplicationSession a ProvisionEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProvisionEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsProvisionEnablerRuleApplication() is true.
MethodgetProvisionEnablerRuleApplicationSessionForDistributor
Description

Gets the OsidSession associated with the provision enabler assignment service for the given distributor to apply to provision.

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