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

   1 /*
   2  * Copyright (C) 2016, 2017 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 javax.ejb.Remote;
  21 import org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException;
  22 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;
  23
  24 /**
  25  * A remote interface for administrative contact purposes
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 @Remote
  30 public interface AdminContactSessionBeanRemote extends Serializable {
  31
  32         /**
  33          * Deletes given contact instance
  34          * <p>
  35          * @param contact Contact instance being deleted
  36          * <p>
  37          * @throws ContactNotFoundException If the contact is not found
  38          */
  39         void deleteContactData (final Contact contact) throws ContactNotFoundException;
  40
  41         /**
  42          * Adds (persists) given contact instance, if not found. If successfull, the
  43          * field contactId contains the running number, otherwise an exception is
  44          * thrown.
  45          *
  46          * @param contact Contact to be added
  47          * <p>
  48          * @return Updated contact instance
  49          * <p>
  50          * @throws org.mxchange.jcontacts.exceptions.ContactAlreadyAddedException
  51          * Contact already found
  52          */
  53         Contact addContact (final Contact contact) throws ContactAlreadyAddedException;
  54
  55 }