2 * Copyright (C) 2016 Roland Haeder
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.jcontacts.contact;
19 import java.io.Serializable;
20 import java.util.List;
21 import javax.ejb.Remote;
22 import org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException;
23 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;
26 * A remote interface for general contact purposes
28 * @author Roland Haeder<roland@mxchange.org>
31 public interface ContactSessionBeanRemote extends Serializable {
34 * Checks whether the given email address is already registered. The email
35 * address should be validated by EmailAddressValidator before calling this
38 * @param emailAddress Email address to check
40 * @return Whether the email address is already registered
42 boolean isEmailAddressRegistered (final String emailAddress);
45 * Adds (persists) given contact instance, if not found. If successfull, the
46 * field contactId contains the running number, otherwise an exception is
49 * @param contact Contact to be added
51 * @return Updated contact instance
53 * @throws org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException
54 * Contact already found
56 Contact addContact (final Contact contact) throws ContactAlreadyAddedException;
59 * Checks if the given contact can be found by checking the whole list.
61 * @param contact Contact instance to check
63 * @return Whether the found instance or null
65 Contact lookupContact (final Contact contact);
68 * Updates given contact data
70 * @param contact Contact data to update
71 * @param isCellphoneUnlinked Whether a cellphone entry has been unlinked in
73 * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
75 * @param isFaxUnlinked Whether a fax entry has been unlinked in contact
78 * @return Updated contact instance
80 Contact updateContactData (final Contact contact, final boolean isCellphoneUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);
83 * Updates given contact in database. Please note that the id number must be
84 * set. This method should also make sure that cellphone, land-line and fix
85 * numbers are updated, too.
87 * @param contact Contact to update
89 * @return Updated contact instance
91 Contact updateContactData (final Contact contact);
94 * Returns a list of all found contacts
96 * @return A list of call contacts
98 List<Contact> getAllContacts ();
101 * Returns a list of all registered email addresses.
103 * @return A list of all email addresses
105 List<String> getEmailAddressList ();
108 * Returns a contact instance which has the given id number.
110 * @param contactId Contact id
112 * @return Contact instance
114 * @throws ContactNotFoundException If the contact was not found
116 Contact findContactById (final Long contactId) throws ContactNotFoundException;
119 * Returns a contact instance which has the given email address.
121 * @param emailAddress Email address
123 * @return Contact instance
125 * @throws ContactNotFoundException If the contact was not found
127 Contact findContactByEmailAddress (final String emailAddress) throws ContactNotFoundException;