appointmentplanner.api.Appointment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of appointmentplanner_api Show documentation

The newest version!

/*
 * Copyright (c) 2019 Informatics Fontys FHTenL University of Applied Science Venlo
 */
package appointmentplanner.api;

/**
 * Appointment that is scheduled using the appointment planner.
 *
 * An Appointment is not created from 'the outside API', but created by the
 * appointment planner service, being the actual TimeLine implementation. In
 * the TimeLine, you'll determine if a request can be accepted and an
 * Appointment object can be created. Having an appointment therefore implies
 * that there has been a successful allocation on a day at a time. The
 * appointment is only valid when it is allocated on some timeline.
 *
 * An appointment holds an AppointmentRequest and a start Instant.
 *
 * @author Richard van den Ham {@code [email protected]}
 * @author Pieter van den Hombergh {@code [email protected]}
 */
public interface Appointment extends TimeSlot {

    /**
     * Get the request that led to this appointment.
     *
     * @return the request.
     */
    AppointmentRequest request();

    /**
     * Override the default toString. toString() returns startTime, endTime and description
     * like: "2020-09-12 14:00 - 15:55 ALDA Lesson"
     * This will make your testing and debugging life so much easier.
     *
     * @return String representation of Appointment.
     */
    @Override
    String toString();
}