OpenEngSB Appointment Domain Manual

Version 2.0.0

Open Engineering Service Bus Development Team and Contributors


1. Appointment Domain
1.1. Description
1.2. Functional Interface
1.3. Event Interface

Chapter 1. Appointment Domain

The appointment domain is the tool domain for calendar tools, like gcalendar or Facebook.

1.1. Description

The appointment domain provides the possibility to create, update, delete and retrieve appointments.

1.2. Functional Interface

The following listing presents the Java Domain Interface. This interface also contains information about events raised by this domain.

/**
 * This domain is used to integrate different calendar programs. It can create, update, delete and
 * retrieve Appointments.
 */
public interface AppointmentDomain extends Domain {

    /**
     * creates an appointment and returns the generated id
     */
    String createAppointment(Appointment appointment);

    /**
     * updates an appointment
     */
    void updateAppointment(Appointment appointment);

    /**
     * deletes an appointment
     */
    void deleteAppointment(String id);

    /**
     * loads an appointment
     */
    Appointment loadAppointment(String id);

    /**
     * Returns a list of appointments which are lying between the given start and end time.
     */
    ArrayList<Appointment> getAppointments(Date start, Date end);
}

1.3. Event Interface

The following interface presents the events an appointment connector can throw:

public interface AppointmentDomainEvents extends DomainEvents {
}