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

   1 /*\r
   2  * Copyright (C) 2016 Roland Haeder<roland@mxchange.org>\r
   3  *\r
   4  * This program is free software: you can redistribute it and/or modify\r
   5  * it under the terms of the GNU General Public License as published by\r
   6  * the Free Software Foundation, either version 3 of the License, or\r
   7  * (at your option) any later version.\r
   8  *\r
   9  * This program is distributed in the hope that it will be useful,\r
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  12  * GNU General Public License for more details.\r
  13  *\r
  14  * You should have received a copy of the GNU General Public License\r
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  16  */\r
  17 package org.mxchange.jcontacts.contact;\r
  18 \r
  19 import java.io.Serializable;\r
  20 import java.util.List;\r
  21 import javax.ejb.Remote;\r
  22 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;\r
  23 \r
  24 /**\r
  25  * A remote interface for general contact purposes\r
  26  * <p>\r
  27  * @author Roland Haeder<roland@mxchange.org>\r
  28  */\r
  29 @Remote\r
  30 public interface ContactSessionBeanRemote extends Serializable {\r
  31 \r
  32         /**\r
  33          * Updates given contact data\r
  34          * <p>\r
  35          * @param contact             Contact data to update\r
  36          * @param isCellphoneUnlinked Whether a cellphone entry has been unlinked in contact instance\r
  37          * @param isLandlineUnlinked  Whether a land-line entry has been unlinked in contact instance\r
  38          * @param isFaxUnlinked       Whether a fax entry has been unlinked in contact instance\r
  39          * <p>\r
  40          * @return Updated contact instance\r
  41          */\r
  42         Contact updateContactData (final Contact contact, final boolean isCellphoneUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked);\r
  43 \r
  44         /**\r
  45          * Returns a list of all found contacts\r
  46          * <p>\r
  47          * @return A list of call contacts\r
  48          */\r
  49         List<Contact> getAllContacts ();\r
  50 \r
  51         /**\r
  52          * Returns a list of all registered email addresses.\r
  53          * <p>\r
  54          * @return A list of all email addresses\r
  55          */\r
  56         List<String> getEmailAddressList ();\r
  57 \r
  58         /**\r
  59          * Returns a contact instance which has the given id number.\r
  60          * <p>\r
  61          * @param contactId Contact id\r
  62          * <p>\r
  63          * @return Contact instance\r
  64          * <p>\r
  65          * @throws ContactNotFoundException If the contact was not found\r
  66          */\r
  67         Contact findContactById (final Long contactId) throws ContactNotFoundException;\r
  68 \r
  69 }\r