Addressbook/src/org/mxchange/addressbook/manager/contact/ManageableContact.java

   1 /*\r
   2  * Copyright (C) 2015 Roland Haeder\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.addressbook.manager.contact;\r
  18 \r
  19 import java.util.List;\r
  20 import org.mxchange.addressbook.client.Client;\r
  21 import org.mxchange.addressbook.contact.Contact;\r
  22 import org.mxchange.addressbook.manager.Manageable;\r
  23 \r
  24 /**\r
  25  *\r
  26  * @author Roland Haeder\r
  27  */\r
  28 public interface ManageableContact extends Manageable {\r
  29     /**\r
  30      * Adds given contact to address book\r
  31      *\r
  32      * @param contact Contact being added\r
  33      * @todo Add check for book size\r
  34      */\r
  35     public void addContact (final Contact contact);\r
  36 \r
  37     /**\r
  38      * Let the user add a new other address\r
  39      */\r
  40     public void addOtherAddress();\r
  41 \r
  42     /**\r
  43      * The user can change address data, like street, ZIP code, city and country\r
  44      * of given Contact instance.\r
  45      * \r
  46      * @param contact Instance to change data\r
  47      * @param client Client instance to call back\r
  48      */\r
  49     public void doChangeAddressData (final Contact contact, final Client client);\r
  50 \r
  51     /**\r
  52      * The user can change name data, like gender, surname, family name and\r
  53      * company name (if business contact).\r
  54      * \r
  55      * @param contact Instance to change data\r
  56      * @param client Client instance to call back\r
  57      */\r
  58     public void doChangeNameData (final Contact contact, final Client client);\r
  59 \r
  60     /**\r
  61      * Let the user change other address\r
  62      */\r
  63     public void changeOtherAddress();\r
  64 \r
  65     /**\r
  66      * The user can change other data, like phone numbers or comments.\r
  67      * \r
  68      * @param contact Instance to change data\r
  69      * @param client Client instance to call back\r
  70      */\r
  71     public void doChangeOtherData (final Contact contact, final Client client);\r
  72 \r
  73     /**\r
  74      * Let the user change own data\r
  75      */\r
  76     public void changeOwnData();\r
  77 \r
  78     /**\r
  79      * Let the user delete other address\r
  80      */\r
  81     public void deleteOtherAddress();\r
  82 \r
  83     /**\r
  84      * Asks user for own data\r
  85      */\r
  86     public void doEnterOwnData();\r
  87 \r
  88     /**\r
  89      * Getter for whole list\r
  90      * @return List of all contacts\r
  91      */\r
  92     public List<Contact> getList ();\r
  93 \r
  94     /**\r
  95      * Getter for size\r
  96      *\r
  97      * @return size of contact "book"\r
  98      */\r
  99     public int size();\r
 100 }\r