2 * Copyright (C) 2016 Roland Häder
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.ContactNotFoundException;
25 * A remote interface for general contact purposes
27 * @author Roland Häder<roland@mxchange.org>
30 public interface ContactSessionBeanRemote extends Serializable {
33 * Checks whether the given email address is already registered. The email
34 * address should be validated by EmailAddressValidator before calling this
37 * @param emailAddress Email address to check
39 * @return Whether the email address is already registered
41 boolean isEmailAddressRegistered (final String emailAddress);
44 * Checks if the given contact can be found by checking the whole list.
46 * @param contact Contact instance to check
48 * @return Whether the found instance or null
50 Contact lookupContact (final Contact contact);
53 * Updates given contact data
55 * @param contact Contact data to update
56 * @param isMobileUnlinked Whether a mobile entry has been unlinked in
58 * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
60 * @param isFaxUnlinked Whether a fax entry has been unlinked in contact
63 * @return Updated contact instance
65 Contact updateContactData (final Contact contact, final boolean isMobileUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);
68 * Updates given contact in database. Please note that the id number must be
69 * set. This method should also make sure that mobile, land-line and fix
70 * numbers are updated, too.
72 * @param contact Contact to update
74 * @return Updated contact instance
76 Contact updateContactData (final Contact contact);
79 * Returns a list of all found contacts
81 * @return A list of call contacts
83 List<Contact> getAllContacts ();
86 * Returns a list of all registered email addresses.
88 * @return A list of all email addresses
90 List<String> getEmailAddressList ();
93 * Returns a contact instance which has the given id number.
95 * @param contactId Contact id
97 * @return Contact instance
99 * @throws ContactNotFoundException If the contact was not found
101 Contact findContactById (final Long contactId) throws ContactNotFoundException;
104 * Returns a contact instance which has the given email address.
106 * @param emailAddress Email address
108 * @return Contact instance
110 * @throws ContactNotFoundException If the contact was not found
112 Contact findContactByEmailAddress (final String emailAddress) throws ContactNotFoundException;