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.ContactNotFoundException;
  23
  24 /**
  25  * A remote interface for general contact purposes
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 @Remote
  30 public interface ContactSessionBeanRemote extends Serializable {
  31
  32         /**
  33          * Checks if the given contact can be found by checking the whole list.
  34          * <p>
  35          * @param contact Contact instance to check
  36          * <p>
  37          * @return Whether the found instance or null
  38          */
  39         Contact lookupContact (final Contact contact);
  40
  41         /**
  42          * Updates given contact data
  43          * <p>
  44          * @param contact Contact data to update
  45          * @param isCellphoneUnlinked Whether a cellphone entry has been unlinked in
  46          * contact instance
  47          * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
  48          * contact instance
  49          * @param isFaxUnlinked Whether a fax entry has been unlinked in contact
  50          * instance
  51          * <p>
  52          * @return Updated contact instance
  53          */
  54         Contact updateContactData (final Contact contact, final boolean isCellphoneUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);
  55
  56         /**
  57          * Updates given contact in database. Please note that the id number must be
  58          * set. This method should also make sure that cellphone, land-line and fix
  59          * numbers are updated, too.
  60          * <p>
  61          * @param contact Contact to update
  62          * <p>
  63          * @return Updated contact instance
  64          */
  65         Contact updateContactData (final Contact contact);
  66
  67         /**
  68          * Returns a list of all found contacts
  69          * <p>
  70          * @return A list of call contacts
  71          */
  72         List<Contact> getAllContacts ();
  73
  74         /**
  75          * Returns a list of all registered email addresses.
  76          * <p>
  77          * @return A list of all email addresses
  78          */
  79         List<String> getEmailAddressList ();
  80
  81         /**
  82          * Returns a contact instance which has the given id number.
  83          * <p>
  84          * @param contactId Contact id
  85          * <p>
  86          * @return Contact instance
  87          * <p>
  88          * @throws ContactNotFoundException If the contact was not found
  89          */
  90         Contact findContactById (final Long contactId) throws ContactNotFoundException;
  91
  92 }