Interface FinancialsBudgetingBatchManager

All Superinterfaces:
AutoCloseable, Closeable, FinancialsBudgetingBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface FinancialsBudgetingBatchManager extends OsidManager, FinancialsBudgetingBatchProfile

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

  • BudgetBatchAdminSession : a session to create, modify and delete budgets in bulk
  • BudgetEntryBatchAdminSession : a session to create, modify and delete budget entries in bulk

  • Method Details

    • getBudgetBatchAdminSession

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

    • getBudgetBatchAdminSessionForBusiness

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

    • getBudgetEntryBatchAdminSession

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

    • getBudgetEntryBatchAdminSessionForBusiness

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