Interface ProvisioningBatchManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, ProvisioningBatchProfile, Sourceable
public interface ProvisioningBatchManager extends OsidManager, ProvisioningBatchProfile

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

  • ProvisionBatchAdminSession : a session to create, modify and delete provisions in bulk
  • QueueBatchSession : a session to create, modify and delete queues in bulk
  • RequestBatchAdminSession : a session to create, modify and delete requests in bulk
  • RequestBatchAdminSession : a session to create, modify and delete request transactionss in bulk
  • PoolBatchAdminSession : a session to create, modify and delete pools in bulk
  • ProvisionableBatchAdminSession : a session to create, modify and delete provisionables in bulk
  • BrokerBatchAdminSession : a session to create, modify and delete brokers in bulk
  • DistributorBatchAdminSession : a session to create, modify and delete distributors in bulk

  • Method Details

    • getProvisionBatchAdminSession

      ProvisionBatchAdminSession getProvisionBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk provision administration service.
      Returns:
      a ProvisionBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionBatchAdmin()} is {@code true} .

    • getProvisionBatchAdminSessionForDistributor

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

    • getQueueBatchAdminSession

      QueueBatchAdminSession getQueueBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk queue administration service.
      Returns:
      a QueueBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueBatchAdmin()} is {@code true} .

    • getQueueBatchAdminSessionForDistributor

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

    • getRequestBatchAdminSession

      RequestBatchAdminSession getRequestBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk request administration service.
      Returns:
      a RequestBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRequestBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRequestBatchAdmin()} is {@code true} .

    • getRequestBatchAdminSessionForDistributor

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

    • getRequestTransactionBatchAdminSession

      RequestTransactionBatchAdminSession getRequestTransactionBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk request transaction administration service.
      Returns:
      a RequestTransactionBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRequestTransactionBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRequestTransactionBatchAdmin()} is {@code true} .

    • getRequestTransactionBatchAdminSessionForDistributor

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

    • getPoolBatchAdminSession

      PoolBatchAdminSession getPoolBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk pool administration service.
      Returns:
      a PoolBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsPoolBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPoolBatchAdmin()} is {@code true} .

    • getPoolBatchAdminSessionForDistributor

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

    • getProvisionableBatchAdminSession

      ProvisionableBatchAdminSession getProvisionableBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk provisionable administration service.
      Returns:
      a ProvisionableBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProvisionableBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableBatchAdmin()} is {@code true} .

    • getProvisionableBatchAdminSessionForDistributor

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

    • getBrokerBatchAdminSession

      BrokerBatchAdminSession getBrokerBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk broker administration service.
      Returns:
      a BrokerBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsBrokerBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrokerBatchAdmin()} is {@code true} .

    • getBrokerBatchAdminSessionForDistributor

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

    • getDistributorBatchAdminSession

      DistributorBatchAdminSession getDistributorBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk distributor administration service.
      Returns:
      a DistributorBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDistributorBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDistributorBatchAdmin()} is {@code true} .