com.github.triceo.robozonky.api.strategies.InvestmentStrategy Maven / Gradle / Ivy
/*
* Copyright 2016 Lukáš Petrovický
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.triceo.robozonky.api.strategies;
import java.util.Collection;
import java.util.List;
/**
* Determines which loans will be invested into, and how much. What the strategy does or does not allow depends on the
* {@link InvestmentStrategyService} implementation.
*/
public interface InvestmentStrategy {
/**
* Retrieve a list of loans that are acceptable by the strategy, in the order in which they are to be evaluated.
* After an investment has been made into any single one of these loans, the strategy should be called again to
* re-evaluate the resulting situation.
*
* @param availableLoans Loans to be evaluated for acceptability.
* @param portfolio Aggregation of information as to the user's current portfolio.
* @return Acceptable loans, in the iteration order of their decreasing priority, mapped to the recommended
* investment amounts.
*/
List recommend(Collection availableLoans, PortfolioOverview portfolio);
}