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

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   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.ContactAlreadyAddedException;
  23 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;
  24
  25 /**
  26  * A remote interface for general contact purposes
  27  * <p>
  28  * @author Roland Haeder<roland@mxchange.org>
  29  */
  30 @Remote
  31 public interface ContactSessionBeanRemote extends Serializable {
  32
  33         /**
  34          * Deletes given contact instance
  35          * <p>
  36          * @param contact Contact instance being deleted
  37          */
  38         void deleteContactData (final Contact contact);
  39
  40         /**
  41          * Checks whether the given email address is already registered. The email
  42          * address should be validated by EmailAddressValidator before calling this
  43          * method.
  44          * <p>
  45          * @param emailAddress Email address to check
  46          * <p>
  47          * @return Whether the email address is already registered
  48          */
  49         boolean isEmailAddressRegistered (final String emailAddress);
  50
  51         /**
  52          * Adds (persists) given contact instance, if not found. If successfull, the
  53          * field contactId contains the running number, otherwise an exception is
  54          * thrown.
  55          *
  56          * @param contact Contact to be added
  57          * <p>
  58          * @return Updated contact instance
  59          * <p>
  60          * @throws org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException
  61          * Contact already found
  62          */
  63         Contact addContact (final Contact contact) throws ContactAlreadyAddedException;
  64
  65         /**
  66          * Checks if the given contact can be found by checking the whole list.
  67          * <p>
  68          * @param contact Contact instance to check
  69          * <p>
  70          * @return Whether the found instance or null
  71          */
  72         Contact lookupContact (final Contact contact);
  73
  74         /**
  75          * Updates given contact data
  76          * <p>
  77          * @param contact Contact data to update
  78          * @param isCellphoneUnlinked Whether a cellphone entry has been unlinked in
  79          * contact instance
  80          * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
  81          * contact instance
  82          * @param isFaxUnlinked Whether a fax entry has been unlinked in contact
  83          * instance
  84          * <p>
  85          * @return Updated contact instance
  86          */
  87         Contact updateContactData (final Contact contact, final boolean isCellphoneUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);
  88
  89         /**
  90          * Updates given contact in database. Please note that the id number must be
  91          * set. This method should also make sure that cellphone, land-line and fix
  92          * numbers are updated, too.
  93          * <p>
  94          * @param contact Contact to update
  95          * <p>
  96          * @return Updated contact instance
  97          */
  98         Contact updateContactData (final Contact contact);
  99
 100         /**
 101          * Returns a list of all found contacts
 102          * <p>
 103          * @return A list of call contacts
 104          */
 105         List<Contact> getAllContacts ();
 106
 107         /**
 108          * Returns a list of all registered email addresses.
 109          * <p>
 110          * @return A list of all email addresses
 111          */
 112         List<String> getEmailAddressList ();
 113
 114         /**
 115          * Returns a contact instance which has the given id number.
 116          * <p>
 117          * @param contactId Contact id
 118          * <p>
 119          * @return Contact instance
 120          * <p>
 121          * @throws ContactNotFoundException If the contact was not found
 122          */
 123         Contact findContactById (final Long contactId) throws ContactNotFoundException;
 124
 125         /**
 126          * Returns a contact instance which has the given email address.
 127          * <p>
 128          * @param emailAddress Email address
 129          * <p>
 130          * @return Contact instance
 131          * <p>
 132          * @throws ContactNotFoundException If the contact was not found
 133          */
 134         Contact findContactByEmailAddress (final String emailAddress) throws ContactNotFoundException;
 135
 136 }