Interface ModularBudgetService


  • public interface ModularBudgetService
    This service allows Modular Budget information to be retrieved for populating forms
    • Method Detail

      • getModularBudgetAmounts

        List<? extends BudgetModularContract> getModularBudgetAmounts​(BudgetContract budget)
        This service method retrieves Modular Budget information for a given budget. Its primary function is to allow retrieval from either the existing budget representation or from the new Modular Budget microservice.
        Parameters:
        budget - the Budget document to use for retrieving the Modular Budget. Cannot be null.
        Returns:
        a list of Modular Budget entries for each period in the input budget.
      • getModularBudgetForPeriod

        default BudgetModularContract getModularBudgetForPeriod​(List<? extends BudgetModularContract> modularAmounts,
                                                                BudgetPeriodContract period)
        Given a list of Modular Budget amount objects, returns the correct associated with the passed-in budget period based on the "budgetPeriod" property in both.
        Parameters:
        modularAmounts - The list of Modular Budget amounts to iterate through
        period - The Budget Period of the associated desired modular amounts
        Returns:
        the Modular Budget amount that corresponds to the passed-in Budget Period