OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.ProvisioningRulesManager
Implementsosid.OsidManager
osid.provisioning.rules.ProvisioningRulesProfile
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:

  • 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
  • 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
  • BrokerConstrainerLookupSession: a session to retrieve broker constrainer
  • BrokerConstrainerQuerySession: a session to query for broker constrainer
  • BrokerConstrainerSearchSession: a session to search for broker constrainer
  • BrokerConstrainerAdminSession: a session to create and delete broker constrainer
  • 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 constrainer
  • BrokerConstrainerRuleLookupSession: a session to look up broker constrainer to broker mappings
  • BrokerConstrainerRuleApplicationSession: a session to apply broker constrainer 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
  • BrokerConstrainerEnableRuleLookupSession: a session to look up broker constrainer enabler mappings
  • BrokerConstrainerEnablerRuleApplicationSession: a session to apply broker constrainer enablers
  • BrokerProcessorLookupSession: a session to retrieve broker processor
  • BrokerProcessorQuerySession: a session to query for broker processor
  • BrokerProcessorSearchSession: a session to search for broker processor
  • BrokerProcessorAdminSession: a session to create and delete broker processor
  • 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 processor
  • BrokerProcessorRuleLookupSession: a session to look up broker processor to broker mappings
  • BrokerProcessorRuleApplicationSession: a session to apply broker processor 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 enabler mappings
  • BrokerProcessorEnablerRuleApplicationSession: a session to apply broker processor enablers
MethodgetQueueConstrainerLookupSession
Description

Gets the OsidSession associated with the queue constrainer lookup service.

Returnosid.provisioning.rules.QueueConstrainerLookupSessiona QueueConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerLookupSessiona QueueConstrainerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerQuerySessiona QueueConstrainerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerQuerySessiona QueueConstrainerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerSearchSessiona QueueConstrainerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerSearchSessiona QueueConstrainerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerAdminSessiona QueueConstrainerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerAdminSessiona QueueConstrainerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerReceiverqueueConstrainerReceiverthe notification callback
Returnosid.provisioning.rules.QueueConstrainerNotificationSessiona QueueConstrainerNotificationSession
ErrorsNULL_ARGUMENT queueConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerNotification() is false
ComplianceoptionalThis 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.QueueConstrainerReceiverqueueConstrainerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerNotificationSessiona QueueConstrainerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT queueConstrainerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerDistributorSessiona QueueConstrainerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerDistributor() is true.
MethodgetQueueConstrainerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue constrainer to distributors.

Returnosid.provisioning.rules.QueueConstrainerDistributorAssignmentSessiona QueueConstrainerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerDistributorAssignment() is true.
MethodgetQueueConstrainerSmartDistributorSession
Description

Gets the OsidSession to manage queue constrainer smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerSmartDistributorSessiona QueueConstrainerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerSmartDistributor() is false
ComplianceoptionalThis 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.QueueConstrainerRuleLookupSessiona QueueConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerRuleLookupSessiona QueueConstrainerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerRuleApplicationSessiona QueueConstrainerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerRuleApplicationSessiona QueueConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerLookupSessiona QueueConstrainerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerLookupSessiona QueueConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerQuerySessiona QueueConstrainerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerQuerySessiona QueueConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerSearchSessiona QueueConstrainerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerSearchSessiona QueueConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerAdminSessiona QueueConstrainerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerAdminSessiona QueueConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerReceiverqueueConstrainerEnablerReceiverthe notification callback
Returnosid.provisioning.rules.QueueConstrainerEnablerNotificationSessiona QueueConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT queueConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerNotification() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerReceiverqueueConstrainerEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerNotificationSessiona QueueConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT queueConstrainerEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerDistributorSessiona QueueConstrainerEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerDistributor() is true.
MethodgetQueueConstrainerEnablerDistributorAssignmentSession
Description

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

Returnosid.provisioning.rules.QueueConstrainerEnablerDistributorAssignmentSessiona QueueConstrainerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerDistributorAssignment() is true.
MethodgetQueueConstrainerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage queue constrainer enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerSmartDistributorSessiona QueueConstrainerEnablerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerSmartDistributor() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerRuleLookupSessiona QueueConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerRuleLookupSessiona QueueConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueConstrainerEnablerRuleApplicationSessiona QueueConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerRuleApplicationSessiona QueueConstrainerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorLookupSessiona QueueProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorLookupSessiona QueueProcessorLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorQuerySessiona QueueProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorQuerySessiona QueueProcessorQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorSearchSessiona QueueProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorSearchSessiona QueueProcessorSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorAdminSessiona QueueProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorAdminSessiona QueueProcessorAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorReceiverqueueProcessorReceiverthe notification callback
Returnosid.provisioning.rules.QueueProcessorNotificationSessiona QueueProcessorNotificationSession
ErrorsNULL_ARGUMENT queueProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorNotification() is false
ComplianceoptionalThis 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.QueueProcessorReceiverqueueProcessorReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorNotificationSessiona QueueProcessorNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT queueProcessorReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorDistributorSessiona QueueProcessorDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorDistributor() is true.
MethodgetQueueProcessorDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue processor to distributors.

Returnosid.provisioning.rules.QueueProcessorDistributorAssignmentSessiona QueueProcessorDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorDistributorAssignment() is true.
MethodgetQueueProcessorSmartDistributorSession
Description

Gets the OsidSession to manage queue processor smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorSmartDistributorSessiona QueueProcessorSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorSmartDistributor() is false
ComplianceoptionalThis 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.QueueProcessorRuleLookupSessiona QueueProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorRuleLookupSessiona QueueProcessorRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorRuleApplicationSessiona QueueProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorRuleApplicationSessiona QueueProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorEnablerLookupSessiona QueueProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerLookupSessiona QueueProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorEnablerQuerySessiona QueueProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerQuerySessiona QueueProcessorEnablerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorEnablerSearchSessiona QueueProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerSearchSessiona QueueProcessorEnablerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorEnablerAdminSessiona QueueProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerAdminSessiona QueueProcessorEnablerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorEnablerReceiverqueueProcessorEnablerReceiverthe notification callback
Returnosid.provisioning.rules.QueueProcessorEnablerNotificationSessiona QueueProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT queueProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerNotification() is false
ComplianceoptionalThis 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.QueueProcessorEnablerReceiverqueueProcessorEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerNotificationSessiona QueueProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT queueProcessorEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorEnablerDistributorSessiona QueueProcessorEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerDistributor() is true.
MethodgetQueueProcessorEnablerDistributorAssignmentSession
Description

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

Returnosid.provisioning.rules.QueueProcessorEnablerDistributorAssignmentSessiona QueueProcessorEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerDistributorAssignment() is true.
MethodgetQueueProcessorEnablerSmartDistributorSession
Description

Gets the OsidSession to manage queue processor enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerSmartDistributorSessiona QueueProcessorEnablerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerSmartDistributor() is false
ComplianceoptionalThis 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.QueueProcessorEnablerRuleLookupSessiona QueueProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerRuleLookup() is true.
MethodgetQueueProcessorEnablerRuleLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerRuleLookupSessiona QueueProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueProcessorEnablerRuleApplicationSessiona QueueProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerRuleApplicationSessiona QueueProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetPoolConstrainerLookupSession
Description

Gets the OsidSession associated with the pool constrainer lookup service.

Returnosid.provisioning.rules.PoolConstrainerLookupSessiona PoolConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerLookupSessiona PoolConstrainerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerQuerySessiona PoolConstrainerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerQuerySessiona PoolConstrainerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerSearchSessiona PoolConstrainerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerSearchSessiona PoolConstrainerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerAdminSessiona PoolConstrainerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerAdminSessiona PoolConstrainerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerReceiverpoolConstrainerReceiverthe notification callback
Returnosid.provisioning.rules.PoolConstrainerNotificationSessiona PoolConstrainerNotificationSession
ErrorsNULL_ARGUMENT poolConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerNotification() is false
ComplianceoptionalThis 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.PoolConstrainerReceiverpoolConstrainerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerNotificationSessiona PoolConstrainerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT poolConstrainerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerDistributorSessiona PoolConstrainerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolConstrainerDistributor() is true.
MethodgetPoolConstrainerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool constrainer to distributors.

Returnosid.provisioning.rules.PoolConstrainerDistributorAssignmentSessiona PoolConstrainerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPoolConstrainerDistributorAssignment() is true.
MethodgetPoolConstrainerSmartDistributorSession
Description

Gets the OsidSession to manage pool constrainer smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerSmartDistributorSessiona PoolConstrainerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerSmartDistributor() is false
ComplianceoptionalThis 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.PoolConstrainerRuleLookupSessiona PoolConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerRuleLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerRuleLookupSessiona PoolConstrainerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerRuleApplicationSessiona PoolConstrainerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerRuleApplicationSessiona PoolConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerLookupSessiona PoolConstrainerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerLookupSessiona PoolConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerQuerySessiona PoolConstrainerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerQuerySessiona PoolConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerSearchSessiona PoolConstrainerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerSearchSessiona PoolConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerAdminSessiona PoolConstrainerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerAdminSessiona PoolConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerReceiverpoolConstrainerEnablerReceiverthe notification callback
Returnosid.provisioning.rules.PoolConstrainerEnablerNotificationSessiona PoolConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT poolConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerNotification() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerReceiverpoolConstrainerEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerNotificationSessiona PoolConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT poolConstrainerEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerDistributorSessiona PoolConstrainerEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolConstrainerEnablerDistributor() is true.
MethodgetPoolConstrainerEnablerDistributorAssignmentSession
Description

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

Returnosid.provisioning.rules.PoolConstrainerEnablerDistributorAssignmentSessiona PoolConstrainerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPoolConstrainerEnablerDistributorAssignment() is true.
MethodgetPoolConstrainerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage pool constrainer enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerSmartDistributorSessiona PoolConstrainerEnablerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerSmartDistributor() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerRuleLookupSessiona PoolConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerRuleLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerRuleLookupSessiona PoolConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolConstrainerEnablerRuleApplicationSessiona PoolConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerRuleApplicationSessiona PoolConstrainerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorLookupSessiona PoolProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorLookupSessiona PoolProcessorLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorQuerySessiona PoolProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorQuerySessiona PoolProcessorQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorSearchSessiona PoolProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorSearchSessiona PoolProcessorSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorAdminSessiona PoolProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorAdminSessiona PoolProcessorAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorReceiverpoolProcessorReceiverthe notification callback
Returnosid.provisioning.rules.PoolProcessorNotificationSessiona PoolProcessorNotificationSession
ErrorsNULL_ARGUMENT poolProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorNotification() is false
ComplianceoptionalThis 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.PoolProcessorReceiverpoolProcessorReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorNotificationSessiona PoolProcessorNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT poolProcessorReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorDistributorSessiona PoolProcessorDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolProcessorDistributor() is true.
MethodgetPoolProcessorDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool processor to distributors.

Returnosid.provisioning.rules.PoolProcessorDistributorAssignmentSessiona PoolProcessorDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPoolProcessorDistributorAssignment() is true.
MethodgetPoolProcessorSmartDistributorSession
Description

Gets the OsidSession to manage pool processor smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorSmartDistributorSessiona PoolProcessorSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorSmartDistributor() is false
ComplianceoptionalThis 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.PoolProcessorRuleLookupSessiona PoolProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorRuleLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorRuleLookupSessiona PoolProcessorRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorRuleApplicationSessiona PoolProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorRuleApplicationSessiona PoolProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorEnablerLookupSessiona PoolProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerLookupSessiona PoolProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorEnablerQuerySessiona PoolProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerQuerySessiona PoolProcessorEnablerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorEnablerSearchSessiona PoolProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerSearch() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerSearchSessiona PoolProcessorEnablerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorEnablerAdminSessiona PoolProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerAdminSessiona PoolProcessorEnablerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorEnablerReceiverpoolProcessorEnablerReceiverthe notification callback
Returnosid.provisioning.rules.PoolProcessorEnablerNotificationSessiona PoolProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT poolProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerNotification() is false
ComplianceoptionalThis 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.PoolProcessorEnablerReceiverpoolProcessorEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerNotificationSessiona PoolProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT poolProcessorEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorEnablerDistributorSessiona PoolProcessorEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolProcessorEnablerDistributor() is true.
MethodgetPoolProcessorEnablerDistributorAssignmentSession
Description

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

Returnosid.provisioning.rules.PoolProcessorEnablerDistributorAssignmentSessiona PoolProcessorEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPoolProcessorEnablerDistributorAssignment() is true.
MethodgetPoolProcessorEnablerSmartDistributorSession
Description

Gets the OsidSession to manage pool processor enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerSmartDistributorSessiona PoolProcessorEnablerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerSmartDistributor() is false
ComplianceoptionalThis 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.PoolProcessorEnablerRuleLookupSessiona PoolProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsPoolProcessorEnablerRuleLookup() is true.
MethodgetPoolProcessorEnablerRuleLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerRuleLookupSessiona PoolProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PoolProcessorEnablerRuleApplicationSessiona PoolProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolProcessorEnablerRuleApplicationSessiona PoolProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolProcessorEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetBrokerConstrainerLookupSession
Description

Gets the OsidSession associated with the broker constrainer lookup service.

Returnosid.provisioning.rules.BrokerConstrainerLookupSessiona BrokerConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerLookupSessiona BrokerConstrainerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerQuerySessiona BrokerConstrainerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerQuerySessiona BrokerConstrainerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerSearchSessiona BrokerConstrainerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerSearch() is true.
MethodgetBrokerConstrainerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerSearchSessiona BrokerConstrainerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerAdminSessiona BrokerConstrainerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerAdminSessiona BrokerConstrainerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerReceiverbrokerConstrainerReceiverthe notification callback
Returnosid.provisioning.rules.BrokerConstrainerNotificationSessiona BrokerConstrainerNotificationSession
ErrorsNULL_ARGUMENT brokerConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerNotification() is false
ComplianceoptionalThis 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.BrokerConstrainerReceiverbrokerConstrainerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerNotificationSessiona BrokerConstrainerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT brokerConstrainerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerNotification() and supportsVisibleFederation() are true.
MethodgetBrokerConstrainerDistributorSession
Description

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

Returnosid.provisioning.rules.BrokerConstrainerDistributorSessiona BrokerConstrainerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerDistributor() is true.
MethodgetBrokerConstrainerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker constrainer to distributors.

Returnosid.provisioning.rules.BrokerConstrainerDistributorAssignmentSessiona BrokerConstrainerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerDistributorAssignment() is true.
MethodgetBrokerConstrainerSmartDistributorSession
Description

Gets the OsidSession to manage broker constrainer smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerSmartDistributorSessiona BrokerConstrainerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerSmartDistributor() is true.
MethodgetBrokerConstrainerRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerConstrainerRuleLookupSessiona BrokerConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerRuleLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerRuleLookupSessiona BrokerConstrainerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerRuleApplicationSessiona BrokerConstrainerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerRuleApplication() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerRuleApplicationSessiona BrokerConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerEnablerLookupSessiona BrokerConstrainerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerLookupSessiona BrokerConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerEnablerQuerySessiona BrokerConstrainerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerQuerySessiona BrokerConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerEnablerSearchSessiona BrokerConstrainerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerEnablerSearch() is true.
MethodgetBrokerConstrainerEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerSearchSessiona BrokerConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerEnablerAdminSessiona BrokerConstrainerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerAdminSessiona BrokerConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerConstrainerEnablerReceiverbrokerConstrainerEnablerReceiverthe notification callback
Returnosid.provisioning.rules.BrokerConstrainerEnablerNotificationSessiona BrokerConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT brokerConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerNotification() is false
ComplianceoptionalThis 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.BrokerConstrainerEnablerReceiverbrokerConstrainerEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerNotificationSessiona BrokerConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT brokerConstrainerEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerEnablerNotification() and supportsVisibleFederation() are true.
MethodgetBrokerConstrainerEnablerDistributorSession
Description

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

Returnosid.provisioning.rules.BrokerConstrainerEnablerDistributorSessiona BrokerConstrainerEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerEnablerDistributor() is true.
MethodgetBrokerConstrainerEnablerDistributorAssignmentSession
Description

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

Returnosid.provisioning.rules.BrokerConstrainerEnablerDistributorAssignmentSessiona BrokerConstrainerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerEnablerDistributorAssignment() is true.
MethodgetBrokerConstrainerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage broker constrainer enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerSmartDistributorSessiona BrokerConstrainerEnablerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerEnablerSmartDistributor() is true.
MethodgetBrokerConstrainerEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerConstrainerEnablerRuleLookupSessiona BrokerConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerRuleLookup() is false
ComplianceoptionalThis 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.

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

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

Returnosid.provisioning.rules.BrokerConstrainerEnablerRuleApplicationSessiona BrokerConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerConstrainerEnablerRuleApplication() is false
ComplianceoptionalThis 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.

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

Gets the OsidSession associated with the broker processor lookup service.

Returnosid.provisioning.rules.BrokerProcessorLookupSessiona BrokerProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorLookupSessiona BrokerProcessorLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorQuerySessiona BrokerProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorQuerySessiona BrokerProcessorQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorSearchSessiona BrokerProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorSearch() is true.
MethodgetBrokerProcessorSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorSearchSessiona BrokerProcessorSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorAdminSessiona BrokerProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorAdminSessiona BrokerProcessorAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorReceiverbrokerProcessorReceiverthe notification callback
Returnosid.provisioning.rules.BrokerProcessorNotificationSessiona BrokerProcessorNotificationSession
ErrorsNULL_ARGUMENT brokerProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorNotification() is false
ComplianceoptionalThis 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.BrokerProcessorReceiverbrokerProcessorReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorNotificationSessiona BrokerProcessorNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT brokerProcessorReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorNotification() and supportsVisibleFederation() are true.
MethodgetBrokerProcessorDistributorSession
Description

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

Returnosid.provisioning.rules.BrokerProcessorDistributorSessiona BrokerProcessorDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorDistributor() is true.
MethodgetBrokerProcessorDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker processor to distributors.

Returnosid.provisioning.rules.BrokerProcessorDistributorAssignmentSessiona BrokerProcessorDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorDistributorAssignment() is true.
MethodgetBrokerProcessorSmartDistributorSession
Description

Gets the OsidSession to manage broker processor smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorSmartDistributorSessiona BrokerProcessorSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorSmartDistributor() is true.
MethodgetBrokerProcessorRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerProcessorRuleLookupSessiona BrokerProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorRuleLookup() is false
ComplianceoptionalThis 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 broker.

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

Gets the OsidSession associated with the broker processor assignment service.

Returnosid.provisioning.rules.BrokerProcessorRuleApplicationSessiona BrokerProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorRuleApplication() is true.
MethodgetBrokerProcessorRuleApplicationSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorRuleApplicationSessiona BrokerProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorEnablerLookupSessiona BrokerProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerLookup() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerLookupSessiona BrokerProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorEnablerQuerySessiona BrokerProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerQuery() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerQuerySessiona BrokerProcessorEnablerQuerySession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorEnablerSearchSessiona BrokerProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerSearch() is true.
MethodgetBrokerProcessorEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerSearchSessiona BrokerProcessorEnablerSearchSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorEnablerAdminSessiona BrokerProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerAdmin() is false
ComplianceoptionalThis 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.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerAdminSessiona BrokerProcessorEnablerAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.BrokerProcessorEnablerReceiverbrokerProcessorEnablerReceiverthe notification callback
Returnosid.provisioning.rules.BrokerProcessorEnablerNotificationSessiona BrokerProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT brokerProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerNotification() is false
ComplianceoptionalThis 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.BrokerProcessorEnablerReceiverbrokerProcessorEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerNotificationSessiona BrokerProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENT brokerProcessorEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerNotification() and supportsVisibleFederation() are true.
MethodgetBrokerProcessorEnablerDistributorSession
Description

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

Returnosid.provisioning.rules.BrokerProcessorEnablerDistributorSessiona BrokerProcessorEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerDistributor() is true.
MethodgetBrokerProcessorEnablerDistributorAssignmentSession
Description

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

Returnosid.provisioning.rules.BrokerProcessorEnablerDistributorAssignmentSessiona BrokerProcessorEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerDistributorAssignment() is true.
MethodgetBrokerProcessorEnablerSmartDistributorSession
Description

Gets the OsidSession to manage broker processor enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerSmartDistributorSessiona BrokerProcessorEnablerSmartDistributorSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerSmartDistributor() is true.
MethodgetBrokerProcessorEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerProcessorEnablerRuleLookupSessiona BrokerProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerRuleLookup() is true.
MethodgetBrokerProcessorEnablerRuleLookupSessionForDistributor
Description

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

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

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

Returnosid.provisioning.rules.BrokerProcessorEnablerRuleApplicationSessiona BrokerProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerProcessorEnablerRuleApplication() is false
ComplianceoptionalThis 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.

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