src/org/mxchange/addressbook/model/addressbook/entry/AddressbookEntry.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   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.model.addressbook.entry;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import java.util.List;
  22 import org.mxchange.addressbook.model.addressbook.Addressbook;
  23 import org.mxchange.jcontacts.contact.Contact;
  24 import org.mxchange.jcontactsbusiness.BusinessContact;
  25 import org.mxchange.jusercore.model.user.User;
  26
  27 /**
  28  * A POJI for addressbook entries
  29  * <p>
  30  * @author Roland Haeder
  31  */
  32 public interface AddressbookEntry extends Serializable {
  33
  34         /**
  35          * Getter for id number
  36          * <p>
  37          * @return Id number
  38          */
  39         public Long getAddressbookEntryId ();
  40
  41         /**
  42          * Setter for id number
  43          * <p>
  44          * @param addressbookEntryId Id number
  45          */
  46         public void setAddressbookEntryId (final Long addressbookEntryId);
  47
  48         /**
  49          * Getter for business contact
  50          * <p>
  51          * @return Business contact
  52          */
  53         public BusinessContact getAddressbookEntryBusinessContact ();
  54
  55         /**
  56          * Setter for business contact
  57          * <p>
  58          * @param addressbookEntryBusinessContact Business contact
  59          */
  60         public void setAddressbookEntryBusinessContact (final BusinessContact addressbookEntryBusinessContact);
  61
  62         /**
  63          * Getter for entry created timestamp
  64          * <p>
  65          * @return Entry created timestamp
  66          */
  67         public Calendar getAddressbookEntryCreated ();
  68
  69         /**
  70          * Setter for entry created timestamp
  71          * <p>
  72          * @param addressbookEntryCreated Entry created timestamp
  73          */
  74         public void setAddressbookEntryCreated (final Calendar addressbookEntryCreated);
  75
  76         /**
  77          * Getter for private contact
  78          * <p>
  79          * @return Private contact
  80          */
  81         public Contact getAddressbookEntryPrivateContact ();
  82
  83         /**
  84          * Setter for private contact
  85          * <p>
  86          * @param addressbookEntryPrivateContact Private contact
  87          */
  88         public void setAddressbookEntryPrivateContact (final Contact addressbookEntryPrivateContact);
  89
  90         /**
  91          * Getter for user who has added this entry to his/her addressbook
  92          * <p>
  93          * @return User who has added this entry
  94          */
  95         public List<User> getAddressbookEntryUserAddedList ();
  96
  97         /**
  98          * Setter for user who has added this entry to his/her addressbook
  99          * <p>
 100          * @param addressbookEntryUserAdded User who has added this entry
 101          */
 102         public void setAddressbookEntryUserAddedList (final List<User> addressbookEntryUserAdded);
 103
 104         /**
 105          * Getter for user who has initially created the address book entry
 106          * <p>
 107          * @return User who has created initially this address book entry
 108          */
 109         public List<User> getAddressbookEntryUserOriginList ();
 110
 111         /**
 112          * Setter for user who has initially created the address book entry
 113          * <p>
 114          * @param addressbookEntryUserOrigin User who has created initially this
 115          * address book entry
 116          */
 117         public void setAddressbookEntryUserOriginList (final List<User> addressbookEntryUserOrigin);
 118
 119         /**
 120          * Getter for address book
 121          * <p>
 122          * @return Address book
 123          */
 124         public Addressbook getAddressbookId ();
 125
 126         /**
 127          * Setter for address book
 128          * <p>
 129          * @param addressbookId Address book
 130          */
 131         public void setAddressbookId (final Addressbook addressbookId);
 132
 133 }