OpenEngSB Contact Domain Manual

Version 2.0.0

Open Engineering Service Bus Development Team and Contributors


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

Chapter 1. Contact Domain

The contact domain is the tool domain for all contact books in tools which are using contact books like gcontacts or Facebook.

1.1. Description

The contact domain provides the possibility to create, update, delete and retrieve contacts.

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 maintain different contact books in different tools like gcontacts or facebook.
 */
public interface ContactDomain extends Domain {

    /**
     * creates a contact on the server and returns the generated id
     */
    String createContact(Contact contact);

    /**
     * updates a contact on the server
     */
    void updateContact(Contact contact);

    /**
     * loads a contact from the server
     */
    Contact loadContact(String id);

    /**
     * deletes a contact on the server
     */
    void deleteContact(String id);

    /**
     * retrieves a list of contacts from the server based on "query by example"
     */
    ArrayList<Contact> retrieveContacts(String id, String name, String homepage,
            Location location, Date date, String comment);
}

1.3. Event Interface

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

public interface ContactDomainEvents extends DomainEvents {

}