Interface ProvisioningRulesProxyManager

All Superinterfaces:
AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, ProvisioningRulesProfile, Sourceable

public interface ProvisioningRulesProxyManager extends OsidProxyManager, ProvisioningRulesProfile

The provisioning rules proxy manager provides access to provisioning rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy interface for passing information from server environments. 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
  • Method Details

    • getBrokerEnablerLookupSession

      BrokerEnablerLookupSession getBrokerEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerLookup()} is {@code true} .
    • getBrokerEnablerLookupSessionForDistributor

      BrokerEnablerLookupSession getBrokerEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerEnablerQuerySession

      BrokerEnablerQuerySession getBrokerEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerQuery()} is {@code true} .
    • getBrokerEnablerQuerySessionForDistributor

      BrokerEnablerQuerySession getBrokerEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerEnablerSearchSession

      BrokerEnablerSearchSession getBrokerEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerSearch()} is {@code true} .
    • getBrokerEnablerSearchSessionForDistributor

      BrokerEnablerSearchSession getBrokerEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker enabler search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerEnablerAdminSession

      BrokerEnablerAdminSession getBrokerEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerAdmin()} is {@code true} .
    • getBrokerEnablerAdminSessionForDistributor

      BrokerEnablerAdminSession getBrokerEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerEnablerNotificationSession

      BrokerEnablerNotificationSession getBrokerEnablerNotificationSession(BrokerEnablerReceiver brokerEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker enabler notification service.
      Parameters:
      brokerEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a BrokerEnablerNotificationSession
      Throws:
      NullArgumentException - brokerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerNotification()} is {@code true} .
    • getBrokerEnablerNotificationSessionForDistributor

      BrokerEnablerNotificationSession getBrokerEnablerNotificationSessionForDistributor(BrokerEnablerReceiver brokerEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker enabler notification service for the given distributor.
      Parameters:
      brokerEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - brokerEnablerReceiver,distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerEnablerDistributorSession

      BrokerEnablerDistributorSession getBrokerEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup broker enabler/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerDistributor()} is {@code true} .
    • getBrokerEnablerDistributorAssignmentSession

      BrokerEnablerDistributorAssignmentSession getBrokerEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning broker enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerDistributorAssignment()} is {@code true} .
    • getBrokerEnablerSmartDistributorSession

      BrokerEnablerSmartDistributorSession getBrokerEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage broker enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerSmartDistributor()} is {@code true} .
    • getBrokerEnablerRuleLookupSession

      BrokerEnablerRuleLookupSession getBrokerEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker enabler broker mapping lookup service for looking up the rules applied to a broker.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerRuleLookup()} is {@code true} .
    • getBrokerEnablerRuleLookupSessionForDistributor

      BrokerEnablerRuleLookupSession getBrokerEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker enabler mapping lookup service for the given distributor for looking up rules applied to a broker.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerEnablerRuleApplicationSession

      BrokerEnablerRuleApplicationSession getBrokerEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer assignment service to apply to brokers.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerRuleApplication()} is {@code true} .
    • getBrokerEnablerRuleApplicationSessionForDistributor

      BrokerEnablerRuleApplicationSession getBrokerEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker enabler assignment service for the given distributor to apply to brokers.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerLookupSession

      BrokerConstrainerLookupSession getBrokerConstrainerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerLookup()} is {@code true} .
    • getBrokerConstrainerLookupSessionForDistributor

      BrokerConstrainerLookupSession getBrokerConstrainerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerQuerySession

      BrokerConstrainerQuerySession getBrokerConstrainerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer query service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerQuery()} is {@code true} .
    • getBrokerConstrainerQuerySessionForDistributor

      BrokerConstrainerQuerySession getBrokerConstrainerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerSearchSession

      BrokerConstrainerSearchSession getBrokerConstrainerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer search service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerSearch()} is {@code true} .
    • getBrokerConstrainerSearchSessionForDistributor

      BrokerConstrainerSearchSession getBrokerConstrainerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerAdminSession

      BrokerConstrainerAdminSession getBrokerConstrainerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerAdmin()} is {@code true} .
    • getBrokerConstrainerAdminSessionForDistributor

      BrokerConstrainerAdminSession getBrokerConstrainerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerNotificationSession

      BrokerConstrainerNotificationSession getBrokerConstrainerNotificationSession(BrokerConstrainerReceiver brokerConstrainerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer notification service.
      Parameters:
      brokerConstrainerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a BrokerConstrainerNotificationSession
      Throws:
      NullArgumentException - brokerConstrainerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerNotification()} is {@code true} .
    • getBrokerConstrainerNotificationSessionForDistributor

      BrokerConstrainerNotificationSession getBrokerConstrainerNotificationSessionForDistributor(BrokerConstrainerReceiver brokerConstrainerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer notification service for the given distributor.
      Parameters:
      brokerConstrainerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - brokerConstrainerReceiver , distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerDistributorSession

      BrokerConstrainerDistributorSession getBrokerConstrainerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup broker constrainer/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerDistributor()} is {@code true} .
    • getBrokerConstrainerDistributorAssignmentSession

      BrokerConstrainerDistributorAssignmentSession getBrokerConstrainerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning broker constrainers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerDistributorAssignment()} is {@code true} .
    • getBrokerConstrainerSmartDistributorSession

      BrokerConstrainerSmartDistributorSession getBrokerConstrainerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage broker constrainer smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerSmartDistributor()} is {@code true} .
    • getBrokerConstrainerRuleLookupSession

      BrokerConstrainerRuleLookupSession getBrokerConstrainerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer broker mapping lookup service for looking up the rules applied to a broker.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerRuleLookup()} is {@code true} .
    • getBrokerConstrainerRuleLookupSessionForDistributor

      BrokerConstrainerRuleLookupSession getBrokerConstrainerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer mapping lookup service for the given distributor for looking up rules applied to a broker
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerRuleApplicationSession

      BrokerConstrainerRuleApplicationSession getBrokerConstrainerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer assignment service to apply to brokers.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerRuleApplication()} is {@code true} .
    • getBrokerConstrainerRuleApplicationSessionForDistributor

      BrokerConstrainerRuleApplicationSession getBrokerConstrainerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer assignment service for the given distributor to apply to brokers.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerEnablerLookupSession

      BrokerConstrainerEnablerLookupSession getBrokerConstrainerEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerLookup()} is {@code true} .
    • getBrokerConstrainerEnablerLookupSessionForDistributor

      BrokerConstrainerEnablerLookupSession getBrokerConstrainerEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerEnablerQuerySession

      BrokerConstrainerEnablerQuerySession getBrokerConstrainerEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerQuery()} is {@code true} .
    • getBrokerConstrainerEnablerQuerySessionForDistributor

      BrokerConstrainerEnablerQuerySession getBrokerConstrainerEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerEnablerSearchSession

      BrokerConstrainerEnablerSearchSession getBrokerConstrainerEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerSearch()} is {@code true} .
    • getBrokerConstrainerEnablerSearchSessionForDistributor

      BrokerConstrainerEnablerSearchSession getBrokerConstrainerEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerEnablerAdminSession

      BrokerConstrainerEnablerAdminSession getBrokerConstrainerEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerAdmin()} is {@code true} .
    • getBrokerConstrainerEnablerAdminSessionForDistributor

      BrokerConstrainerEnablerAdminSession getBrokerConstrainerEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}
    • getBrokerConstrainerEnablerNotificationSession

      BrokerConstrainerEnablerNotificationSession getBrokerConstrainerEnablerNotificationSession(BrokerConstrainerEnablerReceiver brokerConstrainerEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler notification service.
      Parameters:
      brokerConstrainerEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - brokerConstrainerEnablerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerNotification()} is {@code true} .
    • getBrokerConstrainerEnablerNotificationSessionForDistributor

      BrokerConstrainerEnablerNotificationSession getBrokerConstrainerEnablerNotificationSessionForDistributor(BrokerConstrainerEnablerReceiver brokerConstrainerEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler notification service for the given distributor.
      Parameters:
      brokerConstrainerEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - brokerConstrainerEnablerReceiver, distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerEnablerDistributorSession

      BrokerConstrainerEnablerDistributorSession getBrokerConstrainerEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup broker constrainer enabler/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerDistributor()} is {@code true} .
    • getBrokerConstrainerEnablerDistributorAssignmentSession

      BrokerConstrainerEnablerDistributorAssignmentSession getBrokerConstrainerEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning broker constrainer enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerDistributorAssignment()} is {@code true} .
    • getBrokerConstrainerEnablerSmartDistributorSession

      BrokerConstrainerEnablerSmartDistributorSession getBrokerConstrainerEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage broker constrainer enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerSmartDistributor()} is {@code true} .
    • getBrokerConstrainerEnablerRuleLookupSession

      BrokerConstrainerEnablerRuleLookupSession getBrokerConstrainerEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler broker mapping lookup service for looking up the rules applied to a broker constrainer.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerRuleLookup()} is {@code true} .
    • getBrokerConstrainerEnablerRuleLookupSessionForDistributor

      BrokerConstrainerEnablerRuleLookupSession getBrokerConstrainerEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      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.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerConstrainerEnablerRuleApplicationSession

      BrokerConstrainerEnablerRuleApplicationSession getBrokerConstrainerEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler assignment service to apply to broker constrainers.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnablerRuleApplication()} is {@code true} .
    • getBrokerConstrainerEnablerRuleApplicationSessionForDistributor

      BrokerConstrainerEnablerRuleApplicationSession getBrokerConstrainerEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker constrainer enabler assignment service for the given distributor to apply to broker constrainers.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerConstrainerEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorLookupSession

      BrokerProcessorLookupSession getBrokerProcessorLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorLookup()} is {@code true} .
    • getBrokerProcessorLookupSessionForDistributor

      BrokerProcessorLookupSession getBrokerProcessorLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true}
    • getBrokerProcessorQuerySession

      BrokerProcessorQuerySession getBrokerProcessorQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor query service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorQuery()} is {@code true} .
    • getBrokerProcessorQuerySessionForDistributor

      BrokerProcessorQuerySession getBrokerProcessorQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorSearchSession

      BrokerProcessorSearchSession getBrokerProcessorSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor search service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorSearch()} is {@code true} .
    • getBrokerProcessorSearchSessionForDistributor

      BrokerProcessorSearchSession getBrokerProcessorSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true}
    • getBrokerProcessorAdminSession

      BrokerProcessorAdminSession getBrokerProcessorAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorAdmin()} is {@code true} .
    • getBrokerProcessorAdminSessionForDistributor

      BrokerProcessorAdminSession getBrokerProcessorAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorNotificationSession

      BrokerProcessorNotificationSession getBrokerProcessorNotificationSession(BrokerProcessorReceiver brokerProcessorReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor notification service.
      Parameters:
      brokerProcessorReceiver - the notification callback
      proxy - a proxy
      Returns:
      a BrokerProcessorNotificationSession
      Throws:
      NullArgumentException - brokerConstrainerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorNotification()} is {@code true} .
    • getBrokerProcessorNotificationSessionForDistributor

      BrokerProcessorNotificationSession getBrokerProcessorNotificationSessionForDistributor(BrokerProcessorReceiver brokerProcessorReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor notification service for the given distributor.
      Parameters:
      brokerProcessorReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - brokerProcessorReceiver , distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorDistributorSession

      BrokerProcessorDistributorSession getBrokerProcessorDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup broker processor/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorDistributor()} is {@code true} .
    • getBrokerProcessorDistributorAssignmentSession

      BrokerProcessorDistributorAssignmentSession getBrokerProcessorDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning broker processors to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorDistributorAssignment()} is {@code true} .
    • getBrokerProcessorSmartDistributorSession

      BrokerProcessorSmartDistributorSession getBrokerProcessorSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage broker processor smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorSmartDistributor()} is {@code true} .
    • getBrokerProcessorRuleLookupSession

      BrokerProcessorRuleLookupSession getBrokerProcessorRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor broker mapping lookup service for looking up the rules applied to a broker.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorRuleLookup()} is {@code true} .
    • getBrokerProcessorRuleLookupSessionForDistributor

      BrokerProcessorRuleLookupSession getBrokerProcessorRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor mapping lookup service for the given distributor for looking up rules applied to a brokers.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorRuleApplicationSession

      BrokerProcessorRuleApplicationSession getBrokerProcessorRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor assignment service to apply to brokers.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorRuleApplication()} is {@code true} .
    • getBrokerProcessorRuleApplicationSessionForDistributor

      BrokerProcessorRuleApplicationSession getBrokerProcessorRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor assignment service for the given distributor to apply to brokers.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorEnablerLookupSession

      BrokerProcessorEnablerLookupSession getBrokerProcessorEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerLookup()} is {@code true} .
    • getBrokerProcessorEnablerLookupSessionForDistributor

      BrokerProcessorEnablerLookupSession getBrokerProcessorEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorEnablerQuerySession

      BrokerProcessorEnablerQuerySession getBrokerProcessorEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerQuery()} is {@code true} .
    • getBrokerProcessorEnablerQuerySessionForDistributor

      BrokerProcessorEnablerQuerySession getBrokerProcessorEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true}
    • getBrokerProcessorEnablerSearchSession

      BrokerProcessorEnablerSearchSession getBrokerProcessorEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerSearch()} is {@code true} .
    • getBrokerProcessorEnablerSearchSessionForDistributor

      BrokerProcessorEnablerSearchSession getBrokerProcessorEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor enabler search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true}
    • getBrokerProcessorEnablerAdminSession

      BrokerProcessorEnablerAdminSession getBrokerProcessorEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerAdmin()} is {@code true} .
    • getBrokerProcessorEnablerAdminSessionForDistributor

      BrokerProcessorEnablerAdminSession getBrokerProcessorEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}
    • getBrokerProcessorEnablerNotificationSession

      BrokerProcessorEnablerNotificationSession getBrokerProcessorEnablerNotificationSession(BrokerProcessorEnablerReceiver brokerProcessorEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor enabler notification service.
      Parameters:
      brokerProcessorEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - brokerProcessorEnablerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerNotification()} is {@code true} .
    • getBrokerProcessorEnablerNotificationSessionForDistributor

      BrokerProcessorEnablerNotificationSession getBrokerProcessorEnablerNotificationSessionForDistributor(BrokerProcessorEnablerReceiver brokerProcessorEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor enabler notification service for the given distributor.
      Parameters:
      brokerProcessorEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - brokerProcessorEnablerReceiver , distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorEnablerDistributorSession

      BrokerProcessorEnablerDistributorSession getBrokerProcessorEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup broker processor enabler/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerDistributor()} is {@code true} .
    • getBrokerProcessorEnablerDistributorAssignmentSession

      BrokerProcessorEnablerDistributorAssignmentSession getBrokerProcessorEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning broker processors enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerDistributorAssignment()} is {@code true} .
    • getBrokerProcessorEnablerSmartDistributorSession

      BrokerProcessorEnablerSmartDistributorSession getBrokerProcessorEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage broker processor enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerSmartDistributor()} is {@code true} .
    • getBrokerProcessorEnablerRuleLookupSession

      BrokerProcessorEnablerRuleLookupSession getBrokerProcessorEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor enabler broker mapping lookup service for looking up the rules applied to a broker processor.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerRuleLookup()} is {@code true} .
    • getBrokerProcessorEnablerRuleLookupSessionForDistributor

      BrokerProcessorEnablerRuleLookupSession getBrokerProcessorEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      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.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getBrokerProcessorEnablerRuleApplicationSession

      BrokerProcessorEnablerRuleApplicationSession getBrokerProcessorEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the broker processor enabler assignment service to apply to broker processors.
      Parameters:
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnablerRuleApplication()} is {@code true} .
    • getBrokerProcessorEnablerRuleApplicationSessionForDistributor

      BrokerProcessorEnablerRuleApplicationSession getBrokerProcessorEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the broker processor enabler assignment service for the given distributor to apply to broker processors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a BrokerProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerProcessorEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueEnablerLookupSession

      QueueEnablerLookupSession getQueueEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerLookup()} is {@code true} .
    • getQueueEnablerLookupSessionForDistributor

      QueueEnablerLookupSession getQueueEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueEnablerQuerySession

      QueueEnablerQuerySession getQueueEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerQuery()} is {@code true} .
    • getQueueEnablerQuerySessionForDistributor

      QueueEnablerQuerySession getQueueEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueEnablerSearchSession

      QueueEnablerSearchSession getQueueEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerSearch()} is {@code true} .
    • getQueueEnablerSearchSessionForDistributor

      QueueEnablerSearchSession getQueueEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueEnablerAdminSession

      QueueEnablerAdminSession getQueueEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerAdmin()} is {@code true} .
    • getQueueEnablerAdminSessionForDistributor

      QueueEnablerAdminSession getQueueEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueEnablerNotificationSession

      QueueEnablerNotificationSession getQueueEnablerNotificationSession(QueueEnablerReceiver queueEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue enabler notification service.
      Parameters:
      queueEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a QueueEnablerNotificationSession
      Throws:
      NullArgumentException - queueReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerNotification()} is {@code true} .
    • getQueueEnablerNotificationSessionForDistributor

      QueueEnablerNotificationSession getQueueEnablerNotificationSessionForDistributor(QueueEnablerReceiver queueEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler notification service for the given distributor.
      Parameters:
      queueEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - queueEnablerReceiver,distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueEnablerDistributorSession

      QueueEnablerDistributorSession getQueueEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup queue enabler/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerDistributor()} is {@code true} .
    • getQueueEnablerDistributorAssignmentSession

      QueueEnablerDistributorAssignmentSession getQueueEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning queue enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerDistributorAssignment()} is {@code true} .
    • getQueueEnablerSmartDistributorSession

      QueueEnablerSmartDistributorSession getQueueEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerSmartDistributor()} is {@code true} .
    • getQueueEnablerRuleLookupSession

      QueueEnablerRuleLookupSession getQueueEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue enabler queue mapping lookup service for looking up the rules applied to a queue.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleLookup()} is {@code true} .
    • getQueueEnablerRuleLookupSessionForDistributor

      QueueEnablerRuleLookupSession getQueueEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler mapping lookup service for the given distributor for looking up rules applied to a queue.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueEnablerRuleApplicationSession

      QueueEnablerRuleApplicationSession getQueueEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer assignment service to apply to queues.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleApplication()} is {@code true} .
    • getQueueEnablerRuleApplicationSessionForDistributor

      QueueEnablerRuleApplicationSession getQueueEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler assignment service for the given distributor to apply to queues.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerLookupSession

      QueueConstrainerLookupSession getQueueConstrainerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerLookup()} is {@code true} .
    • getQueueConstrainerLookupSessionForDistributor

      QueueConstrainerLookupSession getQueueConstrainerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerQuerySession

      QueueConstrainerQuerySession getQueueConstrainerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer query service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerQuery()} is {@code true} .
    • getQueueConstrainerQuerySessionForDistributor

      QueueConstrainerQuerySession getQueueConstrainerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerSearchSession

      QueueConstrainerSearchSession getQueueConstrainerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer search service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerSearch()} is {@code true} .
    • getQueueConstrainerSearchSessionForDistributor

      QueueConstrainerSearchSession getQueueConstrainerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerAdminSession

      QueueConstrainerAdminSession getQueueConstrainerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerAdmin()} is {@code true} .
    • getQueueConstrainerAdminSessionForDistributor

      QueueConstrainerAdminSession getQueueConstrainerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerNotificationSession

      QueueConstrainerNotificationSession getQueueConstrainerNotificationSession(QueueConstrainerReceiver queueConstrainerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer notification service.
      Parameters:
      queueConstrainerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a QueueConstrainerNotificationSession
      Throws:
      NullArgumentException - queueConstrainerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerNotification()} is {@code true} .
    • getQueueConstrainerNotificationSessionForDistributor

      QueueConstrainerNotificationSession getQueueConstrainerNotificationSessionForDistributor(QueueConstrainerReceiver queueConstrainerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer notification service for the given distributor.
      Parameters:
      queueConstrainerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - queueConstrainerReceiver , distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerDistributorSession

      QueueConstrainerDistributorSession getQueueConstrainerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup queue constrainer/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerDistributor()} is {@code true} .
    • getQueueConstrainerDistributorAssignmentSession

      QueueConstrainerDistributorAssignmentSession getQueueConstrainerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning queue constrainers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerDistributorAssignment()} is {@code true} .
    • getQueueConstrainerSmartDistributorSession

      QueueConstrainerSmartDistributorSession getQueueConstrainerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue constrainer smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerSmartDistributor()} is {@code true} .
    • getQueueConstrainerRuleLookupSession

      QueueConstrainerRuleLookupSession getQueueConstrainerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer queue mapping lookup service for looking up the rules applied to a queue.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleLookup()} is {@code true} .
    • getQueueConstrainerRuleLookupSessionForDistributor

      QueueConstrainerRuleLookupSession getQueueConstrainerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer mapping lookup service for the given distributor for looking up rules applied to a queue
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerRuleApplicationSession

      QueueConstrainerRuleApplicationSession getQueueConstrainerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer assignment service to apply to queues.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleApplication()} is {@code true} .
    • getQueueConstrainerRuleApplicationSessionForDistributor

      QueueConstrainerRuleApplicationSession getQueueConstrainerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer assignment service for the given distributor to apply to queues.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerEnablerLookupSession

      QueueConstrainerEnablerLookupSession getQueueConstrainerEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerLookup()} is {@code true} .
    • getQueueConstrainerEnablerLookupSessionForDistributor

      QueueConstrainerEnablerLookupSession getQueueConstrainerEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerEnablerQuerySession

      QueueConstrainerEnablerQuerySession getQueueConstrainerEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerQuery()} is {@code true} .
    • getQueueConstrainerEnablerQuerySessionForDistributor

      QueueConstrainerEnablerQuerySession getQueueConstrainerEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerEnablerSearchSession

      QueueConstrainerEnablerSearchSession getQueueConstrainerEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerSearch()} is {@code true} .
    • getQueueConstrainerEnablerSearchSessionForDistributor

      QueueConstrainerEnablerSearchSession getQueueConstrainerEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enablers earch service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerEnablerAdminSession

      QueueConstrainerEnablerAdminSession getQueueConstrainerEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerAdmin()} is {@code true} .
    • getQueueConstrainerEnablerAdminSessionForDistributor

      QueueConstrainerEnablerAdminSession getQueueConstrainerEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerEnablerNotificationSession

      QueueConstrainerEnablerNotificationSession getQueueConstrainerEnablerNotificationSession(QueueConstrainerEnablerReceiver queueConstrainerEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler notification service.
      Parameters:
      queueConstrainerEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - queueConstrainerEnablerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerNotification()} is {@code true} .
    • getQueueConstrainerEnablerNotificationSessionForDistributor

      QueueConstrainerEnablerNotificationSession getQueueConstrainerEnablerNotificationSessionForDistributor(QueueConstrainerEnablerReceiver queueConstrainerEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler notification service for the given distributor.
      Parameters:
      queueConstrainerEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - queueConstrainerEnablerReceiver, distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerEnablerDistributorSession

      QueueConstrainerEnablerDistributorSession getQueueConstrainerEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup queue constrainer enabler/distributor mappings for queue constrainer enablers.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerDistributor()} is {@code true} .
    • getQueueConstrainerEnablerDistributorAssignmentSession

      QueueConstrainerEnablerDistributorAssignmentSession getQueueConstrainerEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning queue constrainer enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerDistributorAssignment()} is {@code true} .
    • getQueueConstrainerEnablerSmartDistributorSession

      QueueConstrainerEnablerSmartDistributorSession getQueueConstrainerEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue constrainer enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerSmartDistributorSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerSmartDistributor()} is {@code true} .
    • getQueueConstrainerEnablerRuleLookupSession

      QueueConstrainerEnablerRuleLookupSession getQueueConstrainerEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler mapping lookup service .
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleLookup()} is {@code true} .
    • getQueueConstrainerEnablerRuleLookupSessionForDistributor

      QueueConstrainerEnablerRuleLookupSession getQueueConstrainerEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler mapping lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueConstrainerEnablerRuleApplicationSession

      QueueConstrainerEnablerRuleApplicationSession getQueueConstrainerEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler assignment service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleApplication()} is {@code true} .
    • getQueueConstrainerEnablerRuleApplicationSessionForDistributor

      QueueConstrainerEnablerRuleApplicationSession getQueueConstrainerEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler assignment service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorLookupSession

      QueueProcessorLookupSession getQueueProcessorLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorLookup()} is {@code true} .
    • getQueueProcessorLookupSessionForDistributor

      QueueProcessorLookupSession getQueueProcessorLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorQuerySession

      QueueProcessorQuerySession getQueueProcessorQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor query service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorQuery()} is {@code true} .
    • getQueueProcessorQuerySessionForDistributor

      QueueProcessorQuerySession getQueueProcessorQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorQuerySession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorSearchSession

      QueueProcessorSearchSession getQueueProcessorSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor search service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorSearch()} is {@code true} .
    • getQueueProcessorSearchSessionForDistributor

      QueueProcessorSearchSession getQueueProcessorSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor earch service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorSearchSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorAdminSession

      QueueProcessorAdminSession getQueueProcessorAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorAdmin()} is {@code true} .
    • getQueueProcessorAdminSessionForDistributor

      QueueProcessorAdminSession getQueueProcessorAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorAdminSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorNotificationSession

      QueueProcessorNotificationSession getQueueProcessorNotificationSession(QueueProcessorReceiver queueProcessorReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor notification service.
      Parameters:
      queueProcessorReceiver - the notification callback
      proxy - a proxy
      Returns:
      a QueueProcessorNotificationSession
      Throws:
      NullArgumentException - queueProcessorReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorNotification()} is {@code true} .
    • getQueueProcessorNotificationSessionForDistributor

      QueueProcessorNotificationSession getQueueProcessorNotificationSessionForDistributor(QueueProcessorReceiver queueProcessorReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor notification service for the given distributor.
      Parameters:
      queueProcessorReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - queueProcessorReceiver, distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorDistributorSession

      QueueProcessorDistributorSession getQueueProcessorDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup queue processor/distributor mappings for queue processors.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorDistributor()} is {@code true} .
    • getQueueProcessorDistributorAssignmentSession

      QueueProcessorDistributorAssignmentSession getQueueProcessorDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning queue processor to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorDistributorAssignment()} is {@code true} .
    • getQueueProcessorSmartDistributorSession

      QueueProcessorSmartDistributorSession getQueueProcessorSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue processor smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorSmartDistributorSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorSmartDistributor()} is {@code true} .
    • getQueueProcessorRuleLookupSession

      QueueProcessorRuleLookupSession getQueueProcessorRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor mapping lookup service for looking up the rules applied to a queue processor.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleLookup()} is {@code true} .
    • getQueueProcessorRuleLookupSessionForDistributor

      QueueProcessorRuleLookupSession getQueueProcessorRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor mapping lookup service for the given distributor for looking up rules applied to a queue.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorRuleApplicationSession

      QueueProcessorRuleApplicationSession getQueueProcessorRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor assignment service to apply to queues.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleApplication()} is {@code true} .
    • getQueueProcessorRuleApplicationSessionForDistributor

      QueueProcessorRuleApplicationSession getQueueProcessorRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor assignment service for the given distributor to apply to queues.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorEnablerLookupSession

      QueueProcessorEnablerLookupSession getQueueProcessorEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerLookup()} is {@code true} .
    • getQueueProcessorEnablerLookupSessionForDistributor

      QueueProcessorEnablerLookupSession getQueueProcessorEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorEnablerQuerySession

      QueueProcessorEnablerQuerySession getQueueProcessorEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerQuery()} is {@code true} .
    • getQueueProcessorEnablerQuerySessionForDistributor

      QueueProcessorEnablerQuerySession getQueueProcessorEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerQuerySession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorEnablerSearchSession

      QueueProcessorEnablerSearchSession getQueueProcessorEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerSearch()} is {@code true} .
    • getQueueProcessorEnablerSearchSessionForDistributor

      QueueProcessorEnablerSearchSession getQueueProcessorEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enablers earch service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerSearchSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorEnablerAdminSession

      QueueProcessorEnablerAdminSession getQueueProcessorEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerAdmin()} is {@code true} .
    • getQueueProcessorEnablerAdminSessionForDistributor

      QueueProcessorEnablerAdminSession getQueueProcessorEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerAdminSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorEnablerNotificationSession

      QueueProcessorEnablerNotificationSession getQueueProcessorEnablerNotificationSession(QueueProcessorEnablerReceiver queueProcessorEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler notification service.
      Parameters:
      queueProcessorEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - queueProcessorEnablerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerNotification()} is {@code true} .
    • getQueueProcessorEnablerNotificationSessionForDistributor

      QueueProcessorEnablerNotificationSession getQueueProcessorEnablerNotificationSessionForDistributor(QueueProcessorEnablerReceiver queueProcessorEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler notification service for the given distributor.
      Parameters:
      queueProcessorEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - queueProcessorEnablerReceiver, distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorEnablerDistributorSession

      QueueProcessorEnablerDistributorSession getQueueProcessorEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup queue processor enabler/distributor mappings for queue processor enablers.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerDistributor()} is {@code true} .
    • getQueueProcessorEnablerDistributorAssignmentSession

      QueueProcessorEnablerDistributorAssignmentSession getQueueProcessorEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning queue processor enablers to queue processors.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerDistributorAssignment()} is {@code true} .
    • getQueueProcessorEnablerSmartDistributorSession

      QueueProcessorEnablerSmartDistributorSession getQueueProcessorEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue processor enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerSmartDistributorSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerSmartDistributor()} is {@code true} .
    • getQueueProcessorEnablerRuleLookupSession

      QueueProcessorEnablerRuleLookupSession getQueueProcessorEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler mapping lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleLookup()} is {@code true} .
    • getQueueProcessorEnablerRuleLookupSessionForDistributor

      QueueProcessorEnablerRuleLookupSession getQueueProcessorEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler mapping lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getQueueProcessorEnablerRuleApplicationSession

      QueueProcessorEnablerRuleApplicationSession getQueueProcessorEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler assignment service.
      Parameters:
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleApplication()} is {@code true} .
    • getQueueProcessorEnablerRuleApplicationSessionForDistributor

      QueueProcessorEnablerRuleApplicationSession getQueueProcessorEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler assignment service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a QueueProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolEnablerLookupSession

      PoolEnablerLookupSession getPoolEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerLookup()} is {@code true} .
    • getPoolEnablerLookupSessionForDistributor

      PoolEnablerLookupSession getPoolEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolEnablerQuerySession

      PoolEnablerQuerySession getPoolEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerQuery()} is {@code true} .
    • getPoolEnablerQuerySessionForDistributor

      PoolEnablerQuerySession getPoolEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolEnablerSearchSession

      PoolEnablerSearchSession getPoolEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerSearch()} is {@code true} .
    • getPoolEnablerSearchSessionForDistributor

      PoolEnablerSearchSession getPoolEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool enabler search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolEnablerAdminSession

      PoolEnablerAdminSession getPoolEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerAdmin()} is {@code true} .
    • getPoolEnablerAdminSessionForDistributor

      PoolEnablerAdminSession getPoolEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolEnablerNotificationSession

      PoolEnablerNotificationSession getPoolEnablerNotificationSession(PoolEnablerReceiver poolEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool enabler notification service.
      Parameters:
      poolEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a PoolEnablerNotificationSession
      Throws:
      NullArgumentException - poolReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerNotification()} is {@code true} .
    • getPoolEnablerNotificationSessionForDistributor

      PoolEnablerNotificationSession getPoolEnablerNotificationSessionForDistributor(PoolEnablerReceiver poolEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool enabler notification service for the given distributor.
      Parameters:
      poolEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - poolEnablerReceiver or distributorId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolEnablerDistributorSession

      PoolEnablerDistributorSession getPoolEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup pool enabler/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerDistributor()} is {@code true} .
    • getPoolEnablerDistributorAssignmentSession

      PoolEnablerDistributorAssignmentSession getPoolEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning pool enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerDistributorAssignment()} is {@code true} .
    • getPoolEnablerSmartDistributorSession

      PoolEnablerSmartDistributorSession getPoolEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage pool enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerSmartDistributor()} is {@code true} .
    • getPoolEnablerRuleLookupSession

      PoolEnablerRuleLookupSession getPoolEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool enabler pool mapping lookup service for looking up the rules applied to a pool.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerRuleLookup()} is {@code true} .
    • getPoolEnablerRuleLookupSessionForDistributor

      PoolEnablerRuleLookupSession getPoolEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool enabler mapping lookup service for the given distributor for looking up rules applied to a pool.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolEnablerRuleApplicationSession

      PoolEnablerRuleApplicationSession getPoolEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer assignment service to apply to pools.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerRuleApplication()} is {@code true} .
    • getPoolEnablerRuleApplicationSessionForDistributor

      PoolEnablerRuleApplicationSession getPoolEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool enabler assignment service for the given distributor to apply to pools.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerLookupSession

      PoolConstrainerLookupSession getPoolConstrainerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerLookup()} is {@code true} .
    • getPoolConstrainerLookupSessionForDistributor

      PoolConstrainerLookupSession getPoolConstrainerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerQuerySession

      PoolConstrainerQuerySession getPoolConstrainerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer query service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerQuery()} is {@code true} .
    • getPoolConstrainerQuerySessionForDistributor

      PoolConstrainerQuerySession getPoolConstrainerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerQuerySession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerSearchSession

      PoolConstrainerSearchSession getPoolConstrainerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer search service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerSearchSession
      Throws:
      NullArgumentException - a PoolConstrainerSearchSession
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerSearch()} is {@code true} .
    • getPoolConstrainerSearchSessionForDistributor

      PoolConstrainerSearchSession getPoolConstrainerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer earch service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerSearchSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerAdminSession

      PoolConstrainerAdminSession getPoolConstrainerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerAdmin()} is {@code true} .
    • getPoolConstrainerAdminSessionForDistributor

      PoolConstrainerAdminSession getPoolConstrainerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerAdminSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerNotificationSession

      PoolConstrainerNotificationSession getPoolConstrainerNotificationSession(PoolConstrainerReceiver poolConstrainerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer notification service.
      Parameters:
      poolConstrainerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a PoolConstrainerNotificationSession
      Throws:
      NullArgumentException - poolConstrainerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerNotification()} is {@code true} .
    • getPoolConstrainerNotificationSessionForDistributor

      PoolConstrainerNotificationSession getPoolConstrainerNotificationSessionForDistributor(PoolConstrainerReceiver poolConstrainerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer notification service for the given distributor.
      Parameters:
      poolConstrainerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - poolConstrainerReceiver, distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerDistributorSession

      PoolConstrainerDistributorSession getPoolConstrainerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup pool constrainer/distributor mappings for pool constrainers.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerDistributor()} is {@code true} .
    • getPoolConstrainerDistributorAssignmentSession

      PoolConstrainerDistributorAssignmentSession getPoolConstrainerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning pool constrainer to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerDistributorAssignment()} is {@code true} .
    • getPoolConstrainerSmartDistributorSession

      PoolConstrainerSmartDistributorSession getPoolConstrainerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage pool constrainer smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerSmartDistributorSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerSmartDistributor()} is {@code true} .
    • getPoolConstrainerRuleLookupSession

      PoolConstrainerRuleLookupSession getPoolConstrainerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer mapping lookup service for looking up the rules applied to a pool.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerRuleLookup()} is {@code true} .
    • getPoolConstrainerRuleLookupSessionForDistributor

      PoolConstrainerRuleLookupSession getPoolConstrainerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer mapping lookup service for the given distributor for looking up rules applied to a pool.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerRuleApplicationSession

      PoolConstrainerRuleApplicationSession getPoolConstrainerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer assignment service to apply to pools.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerRuleApplication()} is {@code true} .
    • getPoolConstrainerRuleApplicationSessionForDistributor

      PoolConstrainerRuleApplicationSession getPoolConstrainerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer assignment service for the given distributor to apply to pools.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerEnablerLookupSession

      PoolConstrainerEnablerLookupSession getPoolConstrainerEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerLookup()} is {@code true} .
    • getPoolConstrainerEnablerLookupSessionForDistributor

      PoolConstrainerEnablerLookupSession getPoolConstrainerEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerEnablerQuerySession

      PoolConstrainerEnablerQuerySession getPoolConstrainerEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerQuery()} is {@code true} .
    • getPoolConstrainerEnablerQuerySessionForDistributor

      PoolConstrainerEnablerQuerySession getPoolConstrainerEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerEnablerSearchSession

      PoolConstrainerEnablerSearchSession getPoolConstrainerEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerSearch()} is {@code true} .
    • getPoolConstrainerEnablerSearchSessionForDistributor

      PoolConstrainerEnablerSearchSession getPoolConstrainerEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer enablers earch service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerEnablerAdminSession

      PoolConstrainerEnablerAdminSession getPoolConstrainerEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerAdmin()} is {@code true} .
    • getPoolConstrainerEnablerAdminSessionForDistributor

      PoolConstrainerEnablerAdminSession getPoolConstrainerEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerEnablerNotificationSession

      PoolConstrainerEnablerNotificationSession getPoolConstrainerEnablerNotificationSession(PoolConstrainerEnablerReceiver poolConstrainerEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler notification service.
      Parameters:
      poolConstrainerEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - poolConstrainerEnablerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerNotification()} is {@code true} .
    • getPoolConstrainerEnablerNotificationSessionForDistributor

      PoolConstrainerEnablerNotificationSession getPoolConstrainerEnablerNotificationSessionForDistributor(PoolConstrainerEnablerReceiver poolConstrainerEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler notification service for the given distributor.
      Parameters:
      poolConstrainerEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - poolConstrainerEnablerReceiver, distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerEnablerDistributorSession

      PoolConstrainerEnablerDistributorSession getPoolConstrainerEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup pool constrainer enabler/distributor mappings for pool constrainer enablers.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerDistributor()} is {@code true} .
    • getPoolConstrainerEnablerDistributorAssignmentSession

      PoolConstrainerEnablerDistributorAssignmentSession getPoolConstrainerEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning pool constrainer enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerDistributorAssignment()} is {@code true} .
    • getPoolConstrainerEnablerSmartDistributorSession

      PoolConstrainerEnablerSmartDistributorSession getPoolConstrainerEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage pool constrainer enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerSmartDistributorSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerSmartDistributor()} is {@code true} .
    • getPoolConstrainerEnablerRuleLookupSession

      PoolConstrainerEnablerRuleLookupSession getPoolConstrainerEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler mapping lookup service .
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerRuleLookup()} is {@code true} .
    • getPoolConstrainerEnablerRuleLookupSessionForDistributor

      PoolConstrainerEnablerRuleLookupSession getPoolConstrainerEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler mapping lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolConstrainerEnablerRuleApplicationSession

      PoolConstrainerEnablerRuleApplicationSession getPoolConstrainerEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler assignment service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerRuleApplication()} is {@code true} .
    • getPoolConstrainerEnablerRuleApplicationSessionForDistributor

      PoolConstrainerEnablerRuleApplicationSession getPoolConstrainerEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool constrainer enabler assignment service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolConstrainerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorLookupSession

      PoolProcessorLookupSession getPoolProcessorLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorLookup()} is {@code true} .
    • getPoolProcessorLookupSessionForDistributor

      PoolProcessorLookupSession getPoolProcessorLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorQuerySession

      PoolProcessorQuerySession getPoolProcessorQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor query service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorQuery()} is {@code true} .
    • getPoolProcessorQuerySessionForDistributor

      PoolProcessorQuerySession getPoolProcessorQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorQuerySession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorSearchSession

      PoolProcessorSearchSession getPoolProcessorSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor search service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorSearch()} is {@code true} .
    • getPoolProcessorSearchSessionForDistributor

      PoolProcessorSearchSession getPoolProcessorSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor earch service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorSearchSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorAdminSession

      PoolProcessorAdminSession getPoolProcessorAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorAdmin()} is {@code true} .
    • getPoolProcessorAdminSessionForDistributor

      PoolProcessorAdminSession getPoolProcessorAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorAdminSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorNotificationSession

      PoolProcessorNotificationSession getPoolProcessorNotificationSession(PoolProcessorReceiver poolProcessorReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor notification service.
      Parameters:
      poolProcessorReceiver - the notification callback
      proxy - a proxy
      Returns:
      a PoolProcessorNotificationSession
      Throws:
      NullArgumentException - poolProcessorReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorNotification()} is {@code true} .
    • getPoolProcessorNotificationSessionForDistributor

      PoolProcessorNotificationSession getPoolProcessorNotificationSessionForDistributor(PoolProcessorReceiver poolProcessorReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor notification service for the given distributor.
      Parameters:
      poolProcessorReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - poolProcessorReceiver, distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorDistributorSession

      PoolProcessorDistributorSession getPoolProcessorDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup pool processor/distributor mappings for pool processors.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorDistributor()} is {@code true} .
    • getPoolProcessorDistributorAssignmentSession

      PoolProcessorDistributorAssignmentSession getPoolProcessorDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning pool processor to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorDistributorAssignment()} is {@code true} .
    • getPoolProcessorSmartDistributorSession

      PoolProcessorSmartDistributorSession getPoolProcessorSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage pool processor smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorSmartDistributorSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorSmartDistributor()} is {@code true} .
    • getPoolProcessorRuleLookupSession

      PoolProcessorRuleLookupSession getPoolProcessorRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor mapping lookup service for looking up the rules applied to a pool.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorRuleLookup()} is {@code true} .
    • getPoolProcessorRuleLookupSessionForDistributor

      PoolProcessorRuleLookupSession getPoolProcessorRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor mapping lookup service for the given distributor for looking up rules applied to a pool.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorRuleApplicationSession

      PoolProcessorRuleApplicationSession getPoolProcessorRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor assignment service to apply to pool processors.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorRuleApplication()} is {@code true} .
    • getPoolProcessorRuleApplicationSessionForDistributor

      PoolProcessorRuleApplicationSession getPoolProcessorRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor assignment service for the given distributor to apply to pool processors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorEnablerLookupSession

      PoolProcessorEnablerLookupSession getPoolProcessorEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerLookup()} is {@code true} .
    • getPoolProcessorEnablerLookupSessionForDistributor

      PoolProcessorEnablerLookupSession getPoolProcessorEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorEnablerQuerySession

      PoolProcessorEnablerQuerySession getPoolProcessorEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerQuery()} is {@code true} .
    • getPoolProcessorEnablerQuerySessionForDistributor

      PoolProcessorEnablerQuerySession getPoolProcessorEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerQuerySession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorEnablerSearchSession

      PoolProcessorEnablerSearchSession getPoolProcessorEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerSearch()} is {@code true} .
    • getPoolProcessorEnablerSearchSessionForDistributor

      PoolProcessorEnablerSearchSession getPoolProcessorEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor enablers earch service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerSearchSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorEnablerAdminSession

      PoolProcessorEnablerAdminSession getPoolProcessorEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerAdmin()} is {@code true} .
    • getPoolProcessorEnablerAdminSessionForDistributor

      PoolProcessorEnablerAdminSession getPoolProcessorEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerAdminSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorEnablerNotificationSession

      PoolProcessorEnablerNotificationSession getPoolProcessorEnablerNotificationSession(PoolProcessorEnablerReceiver poolProcessorEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor enabler notification service.
      Parameters:
      poolProcessorEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - poolProcessorEnablerReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerNotification()} is {@code true} .
    • getPoolProcessorEnablerNotificationSessionForDistributor

      PoolProcessorEnablerNotificationSession getPoolProcessorEnablerNotificationSessionForDistributor(PoolProcessorEnablerReceiver poolProcessorEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor enabler notification service for the given distributor.
      Parameters:
      poolProcessorEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - poolProcessorEnablerReceiver, distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorEnablerDistributorSession

      PoolProcessorEnablerDistributorSession getPoolProcessorEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup pool processor enabler/distributor mappings for pool processor enablers.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerDistributor()} is {@code true} .
    • getPoolProcessorEnablerDistributorAssignmentSession

      PoolProcessorEnablerDistributorAssignmentSession getPoolProcessorEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning pool processor enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerDistributorAssignment()} is {@code true} .
    • getPoolProcessorEnablerSmartDistributorSession

      PoolProcessorEnablerSmartDistributorSession getPoolProcessorEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage pool processor enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerSmartDistributorSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerSmartDistributor()} is {@code true} .
    • getPoolProcessorEnablerRuleLookupSession

      PoolProcessorEnablerRuleLookupSession getPoolProcessorEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor enabler mapping lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerRuleLookup()} is {@code true} .
    • getPoolProcessorEnablerRuleLookupSessionForDistributor

      PoolProcessorEnablerRuleLookupSession getPoolProcessorEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor enabler mapping lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getPoolProcessorEnablerRuleApplicationSession

      PoolProcessorEnablerRuleApplicationSession getPoolProcessorEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the pool processor enabler assignment service.
      Parameters:
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerRuleApplication()} is {@code true} .
    • getPoolProcessorEnablerRuleApplicationSessionForDistributor

      PoolProcessorEnablerRuleApplicationSession getPoolProcessorEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the pool processor enabler assignment service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a PoolProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolProcessorEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionEnablerLookupSession

      ProvisionEnablerLookupSession getProvisionEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provision enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerLookup()} is {@code true} .
    • getProvisionEnablerLookupSessionForDistributor

      ProvisionEnablerLookupSession getProvisionEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provision enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionableEnablerLookupSession

      ProvisionableEnablerLookupSession getProvisionableEnablerLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provisionable enabler lookup service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerLookup()} is {@code true} .
    • getProvisionableEnablerLookupSessionForDistributor

      ProvisionableEnablerLookupSession getProvisionableEnablerLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provisionable enabler lookup service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionableEnablerQuerySession

      ProvisionableEnablerQuerySession getProvisionableEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provisionable enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerQuery()} is {@code true} .
    • getProvisionableEnablerQuerySessionForDistributor

      ProvisionableEnablerQuerySession getProvisionableEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provisionable enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionableEnablerSearchSession

      ProvisionableEnablerSearchSession getProvisionableEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provisionable enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerSearch()} is {@code true} .
    • getProvisionableEnablerSearchSessionForDistributor

      ProvisionableEnablerSearchSession getProvisionableEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provisionable enabler search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionableEnablerAdminSession

      ProvisionableEnablerAdminSession getProvisionableEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provisionable enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerAdmin()} is {@code true} .
    • getProvisionableEnablerAdminSessionForDistributor

      ProvisionableEnablerAdminSession getProvisionableEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provisionable enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionableEnablerNotificationSession

      ProvisionableEnablerNotificationSession getProvisionableEnablerNotificationSession(ProvisionableEnablerReceiver provisionableEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provisionable enabler notification service.
      Parameters:
      provisionableEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a ProvisionableEnablerNotificationSession
      Throws:
      NullArgumentException - provisionableReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerNotification()} is {@code true} .
    • getProvisionableEnablerNotificationSessionForDistributor

      ProvisionableEnablerNotificationSession getProvisionableEnablerNotificationSessionForDistributor(ProvisionableEnablerReceiver provisionableEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provisionable enabler notification service for the given distributor.
      Parameters:
      provisionableEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - provisionableEnablerReceiver , distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionableEnablerDistributorSession

      ProvisionableEnablerDistributorSession getProvisionableEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup provisionable enabler/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerDistributor()} is {@code true} .
    • getProvisionableEnablerDistributorAssignmentSession

      ProvisionableEnablerDistributorAssignmentSession getProvisionableEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning provisionable enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerDistributorAssignment()} is {@code true} .
    • getProvisionableEnablerSmartDistributorSession

      ProvisionableEnablerSmartDistributorSession getProvisionableEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage provisionable enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerSmartDistributor()} is {@code true} .
    • getProvisionableEnablerRuleLookupSession

      ProvisionableEnablerRuleLookupSession getProvisionableEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provisionable enabler provisionable mapping lookup service for looking up the rules applied to a provisionable.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerRuleLookup()} is {@code true} .
    • getProvisionableEnablerRuleLookupSessionForDistributor

      ProvisionableEnablerRuleLookupSession getProvisionableEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provisionable enabler mapping lookup service for the given distributor for looking up rules applied to a provisionable.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionableEnablerRuleApplicationSession

      ProvisionableEnablerRuleApplicationSession getProvisionableEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provisionable constrainer assignment service to apply to provisionables.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionableEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerRuleApplication()} is {@code true} .
    • getProvisionableEnablerRuleApplicationSessionForDistributor

      ProvisionableEnablerRuleApplicationSession getProvisionableEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provisionable enabler assignment service for the given distributor to apply to provisionables.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionableEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionEnablerQuerySession

      ProvisionEnablerQuerySession getProvisionEnablerQuerySession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provision enabler query service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerQuerySession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerQuery()} is {@code true} .
    • getProvisionEnablerQuerySessionForDistributor

      ProvisionEnablerQuerySession getProvisionEnablerQuerySessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provision enabler query service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerQuerySession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionEnablerSearchSession

      ProvisionEnablerSearchSession getProvisionEnablerSearchSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provision enabler search service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerSearchSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerSearch()} is {@code true} .
    • getProvisionEnablerSearchSessionForDistributor

      ProvisionEnablerSearchSession getProvisionEnablerSearchSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provision enabler search service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerSearchSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionEnablerAdminSession

      ProvisionEnablerAdminSession getProvisionEnablerAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provision enabler administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerAdmin()} is {@code true} .
    • getProvisionEnablerAdminSessionForDistributor

      ProvisionEnablerAdminSession getProvisionEnablerAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provision enabler administration service for the given distributor.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerAdminSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionEnablerNotificationSession

      ProvisionEnablerNotificationSession getProvisionEnablerNotificationSession(ProvisionEnablerReceiver provisionEnablerReceiver, Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provision enabler notification service.
      Parameters:
      provisionEnablerReceiver - the notification callback
      proxy - a proxy
      Returns:
      a ProvisionEnablerNotificationSession
      Throws:
      NullArgumentException - provisionReceiver or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerNotification()} is {@code true} .
    • getProvisionEnablerNotificationSessionForDistributor

      ProvisionEnablerNotificationSession getProvisionEnablerNotificationSessionForDistributor(ProvisionEnablerReceiver provisionEnablerReceiver, Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provision enabler notification service for the given distributor.
      Parameters:
      provisionEnablerReceiver - the notification callback
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerNotificationSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - provisionEnablerReceiver,distributorId , or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionEnablerDistributorSession

      ProvisionEnablerDistributorSession getProvisionEnablerDistributorSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession to lookup provision enabler/distributor mappings.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerDistributorSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerDistributor()} is {@code true} .
    • getProvisionEnablerDistributorAssignmentSession

      ProvisionEnablerDistributorAssignmentSession getProvisionEnablerDistributorAssignmentSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with assigning provision enablers to distributors.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerDistributorAssignmentSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerDistributorAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerDistributorAssignment()} is {@code true} .
    • getProvisionEnablerSmartDistributorSession

      ProvisionEnablerSmartDistributorSession getProvisionEnablerSmartDistributorSession(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage provision enabler smart distributors.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerSmartDistributorSession
      Throws:
      NotFoundException - no distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerSmartDistributor() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerSmartDistributor()} is {@code true} .
    • getProvisionEnablerRuleLookupSession

      ProvisionEnablerRuleLookupSession getProvisionEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provision enabler provision mapping lookup service for looking up the rules applied to a provision.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerRuleLookupSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerRuleLookup()} is {@code true} .
    • getProvisionEnablerRuleLookupSessionForDistributor

      ProvisionEnablerRuleLookupSession getProvisionEnablerRuleLookupSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provision enabler mapping lookup service for the given distributor for looking up rules applied to a provision.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerRuleLookupSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getProvisionEnablerRuleApplicationSession

      ProvisionEnablerRuleApplicationSession getProvisionEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the provision constrainer assignment service to apply to provision.
      Parameters:
      proxy - a proxy
      Returns:
      a ProvisionEnablerRuleApplicationSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerRuleApplication()} is {@code true} .
    • getProvisionEnablerRuleApplicationSessionForDistributor

      ProvisionEnablerRuleApplicationSession getProvisionEnablerRuleApplicationSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the provision enabler assignment service for the given distributor to apply to provision.
      Parameters:
      distributorId - the Id of the Distributor
      proxy - a proxy
      Returns:
      a ProvisionEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Distributor found by the given Id
      NullArgumentException - distributorId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .