com.github.triceo.robozonky.api.notifications.LoanRecommendedEvent Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 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.notifications;

import com.github.triceo.robozonky.api.strategies.InvestmentStrategy;
import com.github.triceo.robozonky.api.strategies.Recommendation;

/**
 * Fired immediately after {@link InvestmentStrategy} has recommended a particular loan.
 * {@link InvestmentRequestedEvent} may be fired next.
 */
public final class LoanRecommendedEvent extends Event {

    private final Recommendation recommendation;

    public LoanRecommendedEvent(final Recommendation recommendation) {
        this.recommendation = recommendation;
    }

    /**
     * @return The recommendation to be submitted to the investing algorithm.
     */
    public Recommendation getRecommendation() {
        return this.recommendation;
    }
}