src/java/org/mxchange/addressbook/beans/contact/list/AddressbookContactListWebViewController.java

   1 /*
   2  * Copyright (C) 2016 - 2022 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 Affero General Public License as
   6  * published by the Free Software Foundation, either version 3 of the
   7  * License, or (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 Affero General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Affero General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.addressbook.beans.contact.list;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;
  22 import org.mxchange.jcontacts.model.contact.Contact;
  23
  24 /**
  25  * An administrative interface for user beans
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface AddressbookContactListWebViewController extends Serializable {
  30
  31         /**
  32          * Returns a contact instance which has the given id number.
  33          * <p>
  34          * @param contactId Contact id
  35          * <p>
  36          * @return Contact instance
  37          * <p>
  38          * @throws ContactNotFoundException If the contact was not found
  39          */
  40         Contact findContactById (final Long contactId) throws ContactNotFoundException;
  41
  42         /**
  43          * Checks whether the given contact is found
  44          * <p>
  45          * @param contact Contact instance
  46          *
  47          * @return Whether contact has been found
  48          */
  49         boolean isContactFound (final Contact contact);
  50
  51         /**
  52          * Getter for all contacts
  53          *
  54          * @return All contact
  55          */
  56         @SuppressWarnings ("ReturnOfCollectionOrArrayField")
  57         List<Contact> getAllContacts ();
  58
  59 }