org.axonframework.test.eventscheduler.ScheduledItem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of axon-test Show documentation

The newest version!

/*
 * Copyright (c) 2010-2022. Axon Framework
 *
 * 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 org.axonframework.test.eventscheduler;

import org.axonframework.eventhandling.EventMessage;

import java.time.Instant;


/**
 * Interface describing an event to be scheduled at a given date and time.
 *
 * @author Allard Buijze
 * @since 1.1
 */
public interface ScheduledItem {

    /**
     * The time the event was scheduled for publication.
     *
     * @return time the event was scheduled for publication
     */
    Instant getScheduleTime();

    /**
     * The Event scheduled for publication.
     *
     * @return the Event scheduled for publication
     */
    EventMessage getEvent();
}