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