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

   1 /*
   2  * Copyright (C) 2016 Roland Haeder<roland@mxchange.org>
   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          * Adds (persists) given contact instance, if not found. If successfull, the
  35          * field contactId contains the running number, otherwise an exception is
  36          * thrown.
  37          *
  38          * @param contact Contact to be added
  39          * <p>
  40          * @return Updated contact instance
  41          * <p>
  42          * @throws org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException
  43          * Contact already found
  44          */
  45         Contact addContact (final Contact contact) throws ContactAlreadyAddedException;
  46
  47         /**
  48          * Checks if the given contact can be found by checking the whole list.
  49          * <p>
  50          * @param contact Contact instance to check
  51          * <p>
  52          * @return Whether the found instance or null
  53          */
  54         Contact lookupContact (final Contact contact);
  55
  56         /**
  57          * Updates given contact data
  58          * <p>
  59          * @param contact Contact data to update
  60          * @param isCellphoneUnlinked Whether a cellphone entry has been unlinked in
  61          * contact instance
  62          * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
  63          * contact instance
  64          * @param isFaxUnlinked Whether a fax entry has been unlinked in contact
  65          * instance
  66          * <p>
  67          * @return Updated contact instance
  68          */
  69         Contact updateContactData (final Contact contact, final boolean isCellphoneUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);
  70
  71         /**
  72          * Updates given contact in database. Please note that the id number must be
  73          * set. This method should also make sure that cellphone, land-line and fix
  74          * numbers are updated, too.
  75          * <p>
  76          * @param contact Contact to update
  77          * <p>
  78          * @return Updated contact instance
  79          */
  80         Contact updateContactData (final Contact contact);
  81
  82         /**
  83          * Returns a list of all found contacts
  84          * <p>
  85          * @return A list of call contacts
  86          */
  87         List<Contact> getAllContacts ();
  88
  89         /**
  90          * Returns a list of all registered email addresses.
  91          * <p>
  92          * @return A list of all email addresses
  93          */
  94         List<String> getEmailAddressList ();
  95
  96         /**
  97          * Returns a contact instance which has the given id number.
  98          * <p>
  99          * @param contactId Contact id
 100          * <p>
 101          * @return Contact instance
 102          * <p>
 103          * @throws ContactNotFoundException If the contact was not found
 104          */
 105         Contact findContactById (final Long contactId) throws ContactNotFoundException;
 106
 107 }