src/org/mxchange/jcontacts/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.contact;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Remote;
  22 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;
  23
  24 /**
  25  * A remote interface for general contact purposes
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 @Remote
  30 public interface ContactSessionBeanRemote extends Serializable {
  31
  32         /**
  33          * Checks whether the given email address is already registered. The email
  34          * address should be validated by EmailAddressValidator before calling this
  35          * method.
  36          * <p>
  37          * @param emailAddress Email address to check
  38          * <p>
  39          * @return Whether the email address is already registered
  40          */
  41         boolean isEmailAddressRegistered (final String emailAddress);
  42
  43         /**
  44          * Checks if the given contact can be found by checking the whole list.
  45          * <p>
  46          * @param contact Contact instance to check
  47          * <p>
  48          * @return Whether the found instance or null
  49          */
  50         Contact lookupContact (final Contact contact);
  51
  52         /**
  53          * Updates given contact data
  54          * <p>
  55          * @param contact Contact data to update
  56          * @param isMobileUnlinked Whether a mobile entry has been unlinked in
  57          * contact instance
  58          * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
  59          * contact instance
  60          * @param isFaxUnlinked Whether a fax entry has been unlinked in contact
  61          * instance
  62          * <p>
  63          * @return Updated contact instance
  64          */
  65         Contact updateContactData (final Contact contact, final boolean isMobileUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);
  66
  67         /**
  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.
  71          * <p>
  72          * @param contact Contact to update
  73          * <p>
  74          * @return Updated contact instance
  75          */
  76         Contact updateContactData (final Contact contact);
  77
  78         /**
  79          * Returns a list of all found contacts
  80          * <p>
  81          * @return A list of call contacts
  82          */
  83         List<Contact> getAllContacts ();
  84
  85         /**
  86          * Returns a list of all registered email addresses.
  87          * <p>
  88          * @return A list of all email addresses
  89          */
  90         List<String> getEmailAddressList ();
  91
  92         /**
  93          * Returns a contact instance which has the given id number.
  94          * <p>
  95          * @param contactId Contact id
  96          * <p>
  97          * @return Contact instance
  98          * <p>
  99          * @throws ContactNotFoundException If the contact was not found
 100          */
 101         Contact findContactById (final Long contactId) throws ContactNotFoundException;
 102
 103         /**
 104          * Returns a contact instance which has the given email address.
 105          * <p>
 106          * @param emailAddress Email address
 107          * <p>
 108          * @return Contact instance
 109          * <p>
 110          * @throws ContactNotFoundException If the contact was not found
 111          */
 112         Contact findContactByEmailAddress (final String emailAddress) throws ContactNotFoundException;
 113
 114 }