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

   1 /*
   2  * Copyright (C) 2016 - 2024 Free Software Foundation
   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.model.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          * Updates given contact data
  34          * <p>
  35          * @param contact            Contact data to update
  36          * @param isMobileUnlinked   Whether a mobile entry has been unlinked in
  37          *                           contact instance
  38          * @param isLandlineUnlinked Whether a land-line entry has been unlinked in
  39          *                           contact instance
  40          * @param isFaxUnlinked      Whether a fax entry has been unlinked in
  41          *                           contact instance
  42          * <p>
  43          * @return Updated contact instance
  44          * <p>
  45          * @throws ContactNotFoundException If the given contact is not found
  46          */
  47         Contact updateContactData (final Contact contact, final boolean isMobileUnlinked, final boolean isLandlineUnlinked, final boolean isFaxUnlinked) throws ContactNotFoundException;
  48
  49         /**
  50          * Updates given contact in database. Please note that the id number must be
  51          * set. This method should also make sure that mobile, land-line and fix
  52          * numbers are updated, too.
  53          * <p>
  54          * @param contact Contact to update
  55          * <p>
  56          * @return Updated contact instance
  57          * <p>
  58          * @throws ContactNotFoundException If the given contact is not found
  59          */
  60         Contact updateContactData (final Contact contact) throws ContactNotFoundException;
  61
  62         /**
  63          * Returns a list of all found contacts
  64          * <p>
  65          * @return A list of call contacts
  66          */
  67         List<Contact> fetchAllContacts ();
  68
  69 }