src/org/mxchange/jcontacts/model/contact/ContactSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17 package org.mxchange.jcontacts.model.contact;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Remote;
  22
  23 /**
  24  * A remote interface for general contact purposes
  25  * <p>
  26  * @author Roland Häder<roland@mxchange.org>
  27  */
  28 @Remote
  29 public interface ContactSessionBeanRemote extends Serializable {
  30
  31         /**
  32          * Checks whether the given email address is already registered. The email
  33          * address should be validated by EmailAddressValidator before calling this
  34          * method.
  35          * <p>
  36          * @param emailAddress Email address to check
  37          * <p>
  38          * @return Whether the email address is already registered
  39          */
  40         boolean isEmailAddressRegistered (final String emailAddress);
  41
  42         /**
  43          * Checks if the given contact can be found by checking the whole list.
  44          * <p>
  45          * @param contact Contact instance to check
  46          * <p>
  47          * @return Whether the found instance or null
  48          */
  49         Contact lookupContact (final Contact contact);
  50
  51         /**
  52          * Updates given contact data
  53          * <p>
  54          * @param contact Contact data to update
  55          * @param isMobileUnlinked Whether a mobile entry has been unlinked in
  56          * contact instance
  57          * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
  58          * contact instance
  59          * @param isFaxUnlinked Whether a fax entry has been unlinked in contact
  60          * instance
  61          * <p>
  62          * @return Updated contact instance
  63          */
  64         Contact updateContactData (final Contact contact, final boolean isMobileUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);
  65
  66         /**
  67          * Updates given contact in database. Please note that the id number must be
  68          * set. This method should also make sure that mobile, land-line and fix
  69          * numbers are updated, too.
  70          * <p>
  71          * @param contact Contact to update
  72          * <p>
  73          * @return Updated contact instance
  74          */
  75         Contact updateContactData (final Contact contact);
  76
  77         /**
  78          * Returns a list of all found contacts
  79          * <p>
  80          * @return A list of call contacts
  81          */
  82         List<Contact> allContacts ();
  83
  84         /**
  85          * Returns a list of all registered email addresses.
  86          * <p>
  87          * @return A list of all email addresses
  88          */
  89         List<String> allEmailAddresses ();
  90
  91 }