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

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

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

Gets the OsidSession associated with the broker enabler lookup service.

Returnosid.provisioning.rules.BrokerEnablerLookupSessiona BrokerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerLookup() is true .
MethodgetBrokerEnablerLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerLookupSessiona BrokerEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerLookup() and supportsVisibleFederation() are true .
MethodgetBrokerEnablerQuerySession
Description

Gets the OsidSession associated with the broker enabler query service.

Returnosid.provisioning.rules.BrokerEnablerQuerySessiona BrokerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerQuery() is true .
MethodgetBrokerEnablerQuerySessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerQuerySessiona BrokerEnablerQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerQuery() and supportsVisibleFederation() are true .
MethodgetBrokerEnablerSearchSession
Description

Gets the OsidSession associated with the broker enabler search service.

Returnosid.provisioning.rules.BrokerEnablerSearchSessiona BrokerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerSearch() is true .
MethodgetBrokerEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerSearchSessiona BrokerEnablerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerSearch() and supportsVisibleFederation() are true .
MethodgetBrokerEnablerAdminSession
Description

Gets the OsidSession associated with the broker enabler administration service.

Returnosid.provisioning.rules.BrokerEnablerAdminSessiona BrokerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerAdmin() is true .
MethodgetBrokerEnablerAdminSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerAdminSessiona BrokerEnablerAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetBrokerEnablerNotificationSession
Description

Gets the OsidSession associated with the broker enabler notification service.

Parametersosid.provisioning.rules.BrokerEnablerReceiverbrokerEnablerReceiverthe notification callback
Returnosid.provisioning.rules.BrokerEnablerNotificationSessiona BrokerEnablerNotificationSession
ErrorsNULL_ARGUMENTbrokerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerNotification() is true .
MethodgetBrokerEnablerNotificationSessionForDistributor
Description

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

Parametersosid.provisioning.rules.BrokerEnablerReceiverbrokerEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerNotificationSessiona BrokerEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTbrokerEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerNotification() and supportsVisibleFederation() are true .
MethodgetBrokerEnablerDistributorSession
Description

Gets the OsidSession to lookup broker enabler/distributor mappings.

Returnosid.provisioning.rules.BrokerEnablerDistributorSessiona BrokerEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerDistributor() is true .
MethodgetBrokerEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning broker enablers to distributors.

Returnosid.provisioning.rules.BrokerEnablerDistributorAssignmentSessiona BrokerEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerDistributorAssignment() is true .
MethodgetBrokerEnablerSmartDistributorSession
Description

Gets the OsidSession to manage broker enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerSmartDistributorSessiona BrokerEnablerSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerSmartDistributor() is true .
MethodgetBrokerEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerEnablerRuleLookupSessiona BrokerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerRuleLookup() is true .
MethodgetBrokerEnablerRuleLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerRuleLookupSessiona BrokerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetBrokerEnablerRuleApplicationSession
Description

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

Returnosid.provisioning.rules.BrokerEnablerRuleApplicationSessiona BrokerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerRuleApplication() is true .
MethodgetBrokerEnablerRuleApplicationSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerEnablerRuleApplicationSessiona BrokerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetBrokerConstrainerLookupSession
Description

Gets the OsidSession associated with the broker constrainer lookup service.

Returnosid.provisioning.rules.BrokerConstrainerLookupSessiona BrokerConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerLookup() 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
UNIMPLEMENTEDsupportsBrokerConstrainerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerQuery() 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
UNIMPLEMENTEDsupportsBrokerConstrainerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerSearch() is true .
MethodgetBrokerConstrainerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerSearchSessiona BrokerConstrainerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerSearch() 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
UNIMPLEMENTEDsupportsBrokerConstrainerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerAdmin() 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_ARGUMENTbrokerConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerNotification() 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_ARGUMENTbrokerConstrainerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerNotification() 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.

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

Gets the OsidSession associated with assigning broker constrainers to distributors.

Returnosid.provisioning.rules.BrokerConstrainerDistributorAssignmentSessiona BrokerConstrainerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerSmartDistributor() is true .
MethodgetBrokerConstrainerRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerConstrainerRuleLookupSessiona BrokerConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerRuleLookup() 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
UNIMPLEMENTEDsupportsBrokerConstrainerRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerRuleApplication() 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
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerLookup() 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
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerQuery() 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
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerEnablerSearch() is true .
MethodgetBrokerConstrainerEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerSearchSessiona BrokerConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerSearch() 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
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerAdmin() 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_ARGUMENTbrokerConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerNotification() 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_ARGUMENTbrokerConstrainerEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerNotification() 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.

Returnosid.provisioning.rules.BrokerConstrainerEnablerDistributorSessiona BrokerConstrainerEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerDistributor() 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
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerConstrainerEnablerSmartDistributor() is true .
MethodgetBrokerConstrainerEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerConstrainerEnablerRuleLookupSessiona BrokerConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerRuleLookup() 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 for looking up rules applied to a broker constrainer.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerEnablerRuleLookupSessiona BrokerConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerRuleLookup() 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 to apply to broker constrainers.

Returnosid.provisioning.rules.BrokerConstrainerEnablerRuleApplicationSessiona BrokerConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerConstrainerEnablerRuleApplication() 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 to apply to broker constrainers.

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

Gets the OsidSession associated with the broker processor lookup service.

Returnosid.provisioning.rules.BrokerProcessorLookupSessiona BrokerProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorLookup() 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
UNIMPLEMENTEDsupportsBrokerProcessorQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorQuery() 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
UNIMPLEMENTEDsupportsBrokerProcessorSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorSearch() is true .
MethodgetBrokerProcessorSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorSearchSessiona BrokerProcessorSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorSearch() 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
UNIMPLEMENTEDsupportsBrokerProcessorAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorAdmin() 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_ARGUMENTbrokerConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorNotification() 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_ARGUMENTbrokerProcessorReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorNotification() 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.

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

Gets the OsidSession associated with assigning broker processors to distributors.

Returnosid.provisioning.rules.BrokerProcessorDistributorAssignmentSessiona BrokerProcessorDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorSmartDistributor() is true .
MethodgetBrokerProcessorRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerProcessorRuleLookupSessiona BrokerProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorRuleLookup() 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 brokers.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorRuleLookupSessiona BrokerProcessorRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorRuleLookup() 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 to apply to brokers.

Returnosid.provisioning.rules.BrokerProcessorRuleApplicationSessiona BrokerProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorRuleApplication() 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 to apply to brokers.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorRuleApplicationSessiona BrokerProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorRuleApplication() 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
UNIMPLEMENTEDsupportsBrokerProcessorEnablerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerLookup() 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
UNIMPLEMENTEDsupportsBrokerProcessorEnablerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerQuery() 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
UNIMPLEMENTEDsupportsBrokerProcessorEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerSearch() is true .
MethodgetBrokerProcessorEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerSearchSessiona BrokerProcessorEnablerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerSearch() 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
UNIMPLEMENTEDsupportsBrokerProcessorEnablerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerAdmin() 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_ARGUMENTbrokerProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerNotification() 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_ARGUMENTbrokerProcessorEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerNotification() 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.

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

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

Returnosid.provisioning.rules.BrokerProcessorEnablerDistributorAssignmentSessiona BrokerProcessorEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsBrokerProcessorEnablerSmartDistributor() is true .
MethodgetBrokerProcessorEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.BrokerProcessorEnablerRuleLookupSessiona BrokerProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerRuleLookup() 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 for the given distributor for looking up rules applied to a broker processors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.BrokerProcessorEnablerRuleLookupSessiona BrokerProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerRuleLookup() 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 to apply to broker processors.

Returnosid.provisioning.rules.BrokerProcessorEnablerRuleApplicationSessiona BrokerProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBrokerProcessorEnablerRuleApplication() 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 to apply to broker processors.

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

Gets the OsidSession associated with the queue enabler lookup service.

Returnosid.provisioning.rules.QueueEnablerLookupSessiona QueueEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerLookup() is true .
MethodgetQueueEnablerLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerLookupSessiona QueueEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerLookup() and supportsVisibleFederation() are true .
MethodgetQueueEnablerQuerySession
Description

Gets the OsidSession associated with the queue enabler query service.

Returnosid.provisioning.rules.QueueEnablerQuerySessiona QueueEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerQuery() is true .
MethodgetQueueEnablerQuerySessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerQuerySessiona QueueEnablerQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerQuery() and supportsVisibleFederation() are true .
MethodgetQueueEnablerSearchSession
Description

Gets the OsidSession associated with the queue enabler search service.

Returnosid.provisioning.rules.QueueEnablerSearchSessiona QueueEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerSearch() is true .
MethodgetQueueEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerSearchSessiona QueueEnablerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerSearch() and supportsVisibleFederation() are true .
MethodgetQueueEnablerAdminSession
Description

Gets the OsidSession associated with the queue enabler administration service.

Returnosid.provisioning.rules.QueueEnablerAdminSessiona QueueEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerAdmin() is true .
MethodgetQueueEnablerAdminSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerAdminSessiona QueueEnablerAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetQueueEnablerNotificationSession
Description

Gets the OsidSession associated with the queue enabler notification service.

Parametersosid.provisioning.rules.QueueEnablerReceiverqueueEnablerReceiverthe notification callback
Returnosid.provisioning.rules.QueueEnablerNotificationSessiona QueueEnablerNotificationSession
ErrorsNULL_ARGUMENTqueueReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerNotification() is true .
MethodgetQueueEnablerNotificationSessionForDistributor
Description

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

Parametersosid.provisioning.rules.QueueEnablerReceiverqueueEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerNotificationSessiona QueueEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTqueueEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerNotification() and supportsVisibleFederation() are true .
MethodgetQueueEnablerDistributorSession
Description

Gets the OsidSession to lookup queue enabler/distributor mappings.

Returnosid.provisioning.rules.QueueEnablerDistributorSessiona QueueEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerDistributor() is true .
MethodgetQueueEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning queue enablers to distributors.

Returnosid.provisioning.rules.QueueEnablerDistributorAssignmentSessiona QueueEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerDistributorAssignment() is true .
MethodgetQueueEnablerSmartDistributorSession
Description

Gets the OsidSession to manage queue enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerSmartDistributorSessiona QueueEnablerSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerSmartDistributor() is true .
MethodgetQueueEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.QueueEnablerRuleLookupSessiona QueueEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerRuleLookup() is true .
MethodgetQueueEnablerRuleLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerRuleLookupSessiona QueueEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetQueueEnablerRuleApplicationSession
Description

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

Returnosid.provisioning.rules.QueueEnablerRuleApplicationSessiona QueueEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerRuleApplication() is true .
MethodgetQueueEnablerRuleApplicationSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.QueueEnablerRuleApplicationSessiona QueueEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetQueueConstrainerLookupSession
Description

Gets the OsidSession associated with the queue constrainer lookup service.

Returnosid.provisioning.rules.QueueConstrainerLookupSessiona QueueConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerLookup() 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
UNIMPLEMENTEDsupportsQueueConstrainerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerQuery() 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
UNIMPLEMENTEDsupportsQueueConstrainerSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerSearch() 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
UNIMPLEMENTEDsupportsQueueConstrainerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerAdmin() 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_ARGUMENTqueueConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerNotification() 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_ARGUMENTqueueConstrainerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerNotification() 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
UNIMPLEMENTEDsupportsQueueConstrainerDistributor() 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
UNIMPLEMENTEDsupportsQueueConstrainerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerSmartDistributor() 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
UNIMPLEMENTEDsupportsQueueConstrainerRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerRuleLookup() 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
UNIMPLEMENTEDsupportsQueueConstrainerRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerRuleApplication() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerLookup() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerQuery() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerSearch() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerAdmin() 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_ARGUMENTqueueConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerNotification() 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_ARGUMENTqueueConstrainerEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerNotification() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerDistributor() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerSmartDistributor() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerRuleLookup() 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
UNIMPLEMENTEDsupportsQueueConstrainerEnablerRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueConstrainerEnablerRuleApplication() 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
UNIMPLEMENTEDsupportsQueueProcessorLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorLookup() 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
UNIMPLEMENTEDsupportsQueueProcessorQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorQuery() 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
UNIMPLEMENTEDsupportsQueueProcessorSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorSearch() 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
UNIMPLEMENTEDsupportsQueueProcessorAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorAdmin() 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_ARGUMENTqueueProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorNotification() 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_ARGUMENTqueueProcessorReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorNotification() 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
UNIMPLEMENTEDsupportsQueueProcessorDistributor() 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
UNIMPLEMENTEDsupportsQueueProcessorDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorSmartDistributor() 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
UNIMPLEMENTEDsupportsQueueProcessorRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorRuleLookup() 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
UNIMPLEMENTEDsupportsQueueProcessorRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorRuleApplication() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerLookup() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerQuery() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerSearch() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerAdmin() 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_ARGUMENTqueueProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerNotification() 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_ARGUMENTqueueProcessorEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerNotification() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerDistributor() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerSmartDistributor() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerRuleLookup() 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
UNIMPLEMENTEDsupportsQueueProcessorEnablerRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetPoolEnablerLookupSession
Description

Gets the OsidSession associated with the pool enabler lookup service.

Returnosid.provisioning.rules.PoolEnablerLookupSessiona PoolEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerLookup() is true .
MethodgetPoolEnablerLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerLookupSessiona PoolEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerLookup() and supportsVisibleFederation() are true .
MethodgetPoolEnablerQuerySession
Description

Gets the OsidSession associated with the pool enabler query service.

Returnosid.provisioning.rules.PoolEnablerQuerySessiona PoolEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerQuery() is true .
MethodgetPoolEnablerQuerySessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerQuerySessiona PoolEnablerQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerQuery() and supportsVisibleFederation() are true .
MethodgetPoolEnablerSearchSession
Description

Gets the OsidSession associated with the pool enabler search service.

Returnosid.provisioning.rules.PoolEnablerSearchSessiona PoolEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerSearch() is true .
MethodgetPoolEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerSearchSessiona PoolEnablerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerSearch() and supportsVisibleFederation() are true .
MethodgetPoolEnablerAdminSession
Description

Gets the OsidSession associated with the pool enabler administration service.

Returnosid.provisioning.rules.PoolEnablerAdminSessiona PoolEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerAdmin() is true .
MethodgetPoolEnablerAdminSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerAdminSessiona PoolEnablerAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetPoolEnablerNotificationSession
Description

Gets the OsidSession associated with the pool enabler notification service.

Parametersosid.provisioning.rules.PoolEnablerReceiverpoolEnablerReceiverthe notification callback
Returnosid.provisioning.rules.PoolEnablerNotificationSessiona PoolEnablerNotificationSession
ErrorsNULL_ARGUMENTpoolReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerNotification() is true .
MethodgetPoolEnablerNotificationSessionForDistributor
Description

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

Parametersosid.provisioning.rules.PoolEnablerReceiverpoolEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerNotificationSessiona PoolEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTpoolEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerNotification() and supportsVisibleFederation() are true .
MethodgetPoolEnablerDistributorSession
Description

Gets the OsidSession to lookup pool enabler/distributor mappings.

Returnosid.provisioning.rules.PoolEnablerDistributorSessiona PoolEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerDistributor() is true .
MethodgetPoolEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning pool enablers to distributors.

Returnosid.provisioning.rules.PoolEnablerDistributorAssignmentSessiona PoolEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerDistributorAssignment() is true .
MethodgetPoolEnablerSmartDistributorSession
Description

Gets the OsidSession to manage pool enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerSmartDistributorSessiona PoolEnablerSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerSmartDistributor() is true .
MethodgetPoolEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.PoolEnablerRuleLookupSessiona PoolEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerRuleLookup() is true .
MethodgetPoolEnablerRuleLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerRuleLookupSessiona PoolEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetPoolEnablerRuleApplicationSession
Description

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

Returnosid.provisioning.rules.PoolEnablerRuleApplicationSessiona PoolEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerRuleApplication() is true .
MethodgetPoolEnablerRuleApplicationSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.PoolEnablerRuleApplicationSessiona PoolEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetPoolConstrainerLookupSession
Description

Gets the OsidSession associated with the pool constrainer lookup service.

Returnosid.provisioning.rules.PoolConstrainerLookupSessiona PoolConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerLookup() 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
UNIMPLEMENTEDsupportsPoolConstrainerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerQuery() 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
UNIMPLEMENTEDsupportsPoolConstrainerSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerSearch() 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
UNIMPLEMENTEDsupportsPoolConstrainerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerAdmin() 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_ARGUMENTpoolConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerNotification() 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_ARGUMENTpoolConstrainerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerNotification() 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
UNIMPLEMENTEDsupportsPoolConstrainerDistributor() 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
UNIMPLEMENTEDsupportsPoolConstrainerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerSmartDistributor() 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
UNIMPLEMENTEDsupportsPoolConstrainerRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerRuleLookup() 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
UNIMPLEMENTEDsupportsPoolConstrainerRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerRuleApplication() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerLookup() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerQuery() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerSearch() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerAdmin() 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_ARGUMENTpoolConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerNotification() 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_ARGUMENTpoolConstrainerEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerNotification() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerDistributor() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerSmartDistributor() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerRuleLookup() 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
UNIMPLEMENTEDsupportsPoolConstrainerEnablerRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolConstrainerEnablerRuleApplication() 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
UNIMPLEMENTEDsupportsPoolProcessorLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorLookup() 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
UNIMPLEMENTEDsupportsPoolProcessorQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorQuery() 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
UNIMPLEMENTEDsupportsPoolProcessorSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorSearch() 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
UNIMPLEMENTEDsupportsPoolProcessorAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorAdmin() 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_ARGUMENTpoolProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorNotification() 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_ARGUMENTpoolProcessorReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorNotification() 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
UNIMPLEMENTEDsupportsPoolProcessorDistributor() 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
UNIMPLEMENTEDsupportsPoolProcessorDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorSmartDistributor() 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
UNIMPLEMENTEDsupportsPoolProcessorRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorRuleLookup() 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
UNIMPLEMENTEDsupportsPoolProcessorRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorRuleApplication() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerLookup() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerQuery() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerQuery() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerSearch() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerSearch() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerAdmin() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerAdmin() 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_ARGUMENTpoolProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerNotification() 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_ARGUMENTpoolProcessorEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerNotification() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerDistributor() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerDistributorAssignment() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerSmartDistributor() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerRuleLookup() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerRuleLookup() 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
UNIMPLEMENTEDsupportsPoolProcessorEnablerRuleApplication() 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_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPoolProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolProcessorEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetProvisionableEnablerLookupSession
Description

Gets the OsidSession associated with the provisionable enabler lookup service.

Returnosid.provisioning.rules.ProvisionableEnablerLookupSessiona ProvisionableEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerLookup() is true .
MethodgetProvisionableEnablerLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerLookupSessiona ProvisionableEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerLookup() and supportsVisibleFederation() are true .
MethodgetProvisionableEnablerQuerySession
Description

Gets the OsidSession associated with the provisionable enabler query service.

Returnosid.provisioning.rules.ProvisionableEnablerQuerySessiona ProvisionableEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerQuery() is true .
MethodgetProvisionableEnablerQuerySessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerQuerySessiona ProvisionableEnablerQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerQuery() and supportsVisibleFederation() are true .
MethodgetProvisionableEnablerSearchSession
Description

Gets the OsidSession associated with the provisionable enabler search service.

Returnosid.provisioning.rules.ProvisionableEnablerSearchSessiona ProvisionableEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerSearch() is true .
MethodgetProvisionableEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerSearchSessiona ProvisionableEnablerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerSearch() and supportsVisibleFederation() are true .
MethodgetProvisionableEnablerAdminSession
Description

Gets the OsidSession associated with the provisionable enabler administration service.

Returnosid.provisioning.rules.ProvisionableEnablerAdminSessiona ProvisionableEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerAdmin() is true .
MethodgetProvisionableEnablerAdminSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerAdminSessiona ProvisionableEnablerAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetProvisionableEnablerNotificationSession
Description

Gets the OsidSession associated with the provisionable enabler notification service.

Parametersosid.provisioning.rules.ProvisionableEnablerReceiverprovisionableEnablerReceiverthe notification callback
Returnosid.provisioning.rules.ProvisionableEnablerNotificationSessiona ProvisionableEnablerNotificationSession
ErrorsNULL_ARGUMENTprovisionableReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerNotification() is true .
MethodgetProvisionableEnablerNotificationSessionForDistributor
Description

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

Parametersosid.provisioning.rules.ProvisionableEnablerReceiverprovisionableEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerNotificationSessiona ProvisionableEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTprovisionableEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerNotification() and supportsVisibleFederation() are true .
MethodgetProvisionableEnablerDistributorSession
Description

Gets the OsidSession to lookup provisionable enabler/distributor mappings.

Returnosid.provisioning.rules.ProvisionableEnablerDistributorSessiona ProvisionableEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerDistributor() is true .
MethodgetProvisionableEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provisionable enablers to distributors.

Returnosid.provisioning.rules.ProvisionableEnablerDistributorAssignmentSessiona ProvisionableEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerDistributorAssignment() is true .
MethodgetProvisionableEnablerSmartDistributorSession
Description

Gets the OsidSession to manage provisionable enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerSmartDistributorSessiona ProvisionableEnablerSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerSmartDistributor() is true .
MethodgetProvisionableEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.ProvisionableEnablerRuleLookupSessiona ProvisionableEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerRuleLookup() is true .
MethodgetProvisionableEnablerRuleLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerRuleLookupSessiona ProvisionableEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetProvisionableEnablerRuleApplicationSession
Description

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

Returnosid.provisioning.rules.ProvisionableEnablerRuleApplicationSessiona ProvisionableEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerRuleApplication() is true .
MethodgetProvisionableEnablerRuleApplicationSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionableEnablerRuleApplicationSessiona ProvisionableEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionableEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableEnablerRuleApplication() and supportsVisibleFederation() are true .
MethodgetProvisionEnablerLookupSession
Description

Gets the OsidSession associated with the provision enabler lookup service.

Returnosid.provisioning.rules.ProvisionEnablerLookupSessiona ProvisionEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerLookup() is true .
MethodgetProvisionEnablerLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerLookupSessiona ProvisionEnablerLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerLookup() and supportsVisibleFederation() are true .
MethodgetProvisionEnablerQuerySession
Description

Gets the OsidSession associated with the provision enabler query service.

Returnosid.provisioning.rules.ProvisionEnablerQuerySessiona ProvisionEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerQuery() is true .
MethodgetProvisionEnablerQuerySessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerQuerySessiona ProvisionEnablerQuerySession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerQuery() and supportsVisibleFederation() are true .
MethodgetProvisionEnablerSearchSession
Description

Gets the OsidSession associated with the provision enabler search service.

Returnosid.provisioning.rules.ProvisionEnablerSearchSessiona ProvisionEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerSearch() is true .
MethodgetProvisionEnablerSearchSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerSearchSessiona ProvisionEnablerSearchSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerSearch() and supportsVisibleFederation() are true .
MethodgetProvisionEnablerAdminSession
Description

Gets the OsidSession associated with the provision enabler administration service.

Returnosid.provisioning.rules.ProvisionEnablerAdminSessiona ProvisionEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerAdmin() is true .
MethodgetProvisionEnablerAdminSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerAdminSessiona ProvisionEnablerAdminSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerAdmin() and supportsVisibleFederation() are true .
MethodgetProvisionEnablerNotificationSession
Description

Gets the OsidSession associated with the provision enabler notification service.

Parametersosid.provisioning.rules.ProvisionEnablerReceiverprovisionEnablerReceiverthe notification callback
Returnosid.provisioning.rules.ProvisionEnablerNotificationSessiona ProvisionEnablerNotificationSession
ErrorsNULL_ARGUMENTprovisionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerNotification() is true .
MethodgetProvisionEnablerNotificationSessionForDistributor
Description

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

Parametersosid.provisioning.rules.ProvisionEnablerReceiverprovisionEnablerReceiverthe notification callback
osid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerNotificationSessiona ProvisionEnablerNotificationSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTprovisionEnablerReceiver or distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerNotification() and supportsVisibleFederation() are true .
MethodgetProvisionEnablerDistributorSession
Description

Gets the OsidSession to lookup provision enabler/distributor mappings.

Returnosid.provisioning.rules.ProvisionEnablerDistributorSessiona ProvisionEnablerDistributorSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerDistributor() is true .
MethodgetProvisionEnablerDistributorAssignmentSession
Description

Gets the OsidSession associated with assigning provision enablers to distributors.

Returnosid.provisioning.rules.ProvisionEnablerDistributorAssignmentSessiona ProvisionEnablerDistributorAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerDistributorAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerDistributorAssignment() is true .
MethodgetProvisionEnablerSmartDistributorSession
Description

Gets the OsidSession to manage provision enabler smart distributors.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerSmartDistributorSessiona ProvisionEnablerSmartDistributorSession
ErrorsNOT_FOUNDno distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerSmartDistributor() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerSmartDistributor() is true .
MethodgetProvisionEnablerRuleLookupSession
Description

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

Returnosid.provisioning.rules.ProvisionEnablerRuleLookupSessiona ProvisionEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerRuleLookup() is true .
MethodgetProvisionEnablerRuleLookupSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerRuleLookupSessiona ProvisionEnablerRuleLookupSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerRuleLookup() and supportsVisibleFederation() are true .
MethodgetProvisionEnablerRuleApplicationSession
Description

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

Returnosid.provisioning.rules.ProvisionEnablerRuleApplicationSessiona ProvisionEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerRuleApplication() is true .
MethodgetProvisionEnablerRuleApplicationSessionForDistributor
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.rules.ProvisionEnablerRuleApplicationSessiona ProvisionEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProvisionEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionEnablerRuleApplication() and supportsVisibleFederation() are true .