Interface FinancialsBatchManager

All Superinterfaces:
AutoCloseable, Closeable, FinancialsBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface FinancialsBatchManager extends OsidManager, FinancialsBatchProfile

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

  • AccountBatchAdminSession : a session to create, modify and delete accounts in bulk
  • ActivityBatchAdminSession : a session to create, modify and delete activities in bulk
  • FiscalPeriodBatchAdminSession : a session to create, modify and delete fiscal periods in bulk
  • BusinessBatchAdminSession : a session to create, modify and delete businesses in bulk

  • Method Details

    • getAccountBatchAdminSession

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

    • getAccountBatchAdminSessionForBusiness

      AccountBatchAdminSession getAccountBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk account administration service for the given business.
      Parameters:
      businessId - the Id of the Business
      Returns:
      an AccountBatchAdminSession
      Throws:
      NotFoundException - no Business found by the given Id
      NullArgumentException - businessId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAccountBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAccountBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getActivityBatchAdminSession

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

    • getActivityBatchAdminSessionForBusiness

      ActivityBatchAdminSession getActivityBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk activity administration service for the given business.
      Parameters:
      businessId - the Id of the Business
      Returns:
      an ActivityBatchAdminSession
      Throws:
      NotFoundException - no Business found by the given Id
      NullArgumentException - businessId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsActivityBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getFiscalPeriodBatchAdminSession

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

    • getFiscalPeriodBatchAdminSessionForBusiness

      FiscalPeriodBatchAdminSession getFiscalPeriodBatchAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk fiscal period administration service for the given business.
      Parameters:
      businessId - the Id of the Business
      Returns:
      a FiscalPeriodBatchAdminSession
      Throws:
      NotFoundException - no Business found by the given Id
      NullArgumentException - businessId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsFiscalPeriodBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsFiscalPeriodBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getBusinessBatchAdminSession

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