Addressbook/src/org/mxchange/addressbook/database/frontend/contact/ContactWrapper.java

   1 /*
   2  * Copyright (C) 2015 Roland Häder
   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.addressbook.database.frontend.contact;
  18
  19 import org.mxchange.addressbook.contact.Contact;
  20 import org.mxchange.addressbook.database.frontend.DatabaseWrapper;
  21 import org.mxchange.addressbook.exceptions.BadTokenException;
  22 import org.mxchange.addressbook.exceptions.ContactAlreadyAddedException;
  23
  24 /**
  25  *
  26  * @author Roland Häder
  27  */
  28 public interface ContactWrapper extends DatabaseWrapper {
  29
  30         /**
  31          * Adds given contact instance to database
  32          *
  33          * @param contact Contact instance to add
  34          * @throws org.mxchange.addressbook.exceptions.ContactAlreadyAddedException If the contact is already added
  35          */
  36         public void addContact (final Contact contact) throws ContactAlreadyAddedException;
  37
  38         /**
  39          * Shuts down the database layer
  40          */
  41         public void doShutdown ();
  42
  43         /**
  44          * Some "getter" for total contacts count
  45          *
  46          * @return Total contacts count
  47          */
  48         public int getContactsCount ();
  49
  50         /**
  51          * Checks if given Contact is found
  52          *
  53          * @param contact Contact instance to check
  54          * @return Whether the given Contact instance is found
  55          * @throws org.mxchange.addressbook.exceptions.BadTokenException Continued throw
  56          */
  57         public boolean isContactFound (final Contact contact) throws BadTokenException;
  58
  59         /**
  60          * Some "getter" for own contact instance
  61          *
  62          * @return Own contact instance
  63          */
  64         public Contact getOwnContact ();
  65
  66         /**
  67          * Checks whether own contact is found
  68          *
  69          * @return Whether own contact is found
  70          */
  71         public boolean isOwnContactFound ();
  72 }