com.github.robozonky.api.notifications.PurchasingStartedEvent Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 The RoboZonky Project
 *
 * 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.robozonky.api.notifications;

import java.util.Collection;
import java.util.Collections;

import com.github.robozonky.api.strategies.ParticipationDescriptor;
import com.github.robozonky.api.strategies.PortfolioOverview;

/**
 * Fired immediately before the loans are submitted to the investing algorithm.
 * Will eventually be followed by {@link PurchasingCompletedEvent}.
 */
public final class PurchasingStartedEvent extends Event {

    private final Collection descriptors;
    private final PortfolioOverview portfolioOverview;

    public PurchasingStartedEvent(final Collection descriptors,
                                  final PortfolioOverview portfolioOverview) {
        super("descriptors");
        this.descriptors = Collections.unmodifiableCollection(descriptors);
        this.portfolioOverview = portfolioOverview;
    }

    /**
     * @return Participations on the secondary marketplace that are available for robotic investment.
     */
    public Collection getDescriptors() {
        return this.descriptors;
    }

    public PortfolioOverview getPortfolioOverview() {
        return portfolioOverview;
    }
}