src/org/mxchange/addressbook/model/addressbook/shared/ShareableAddressbook.java

   1 /*
   2  * Copyright (C) 2016 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.shared;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import org.mxchange.addressbook.model.addressbook.Addressbook;
  22 import org.mxchange.jusercore.model.user.User;
  23
  24 /**
  25  * A POJI for shared address books
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 public interface ShareableAddressbook extends Serializable {
  30
  31         /**
  32          * Getter for shared address book instance
  33          * <p>
  34          * @return Shared address book instance
  35          */
  36         Addressbook getShareAddressbook ();
  37
  38         /**
  39          * Setter for shared address book instance
  40          * <p>
  41          * @param shareAddressbook Shared address book instance
  42          */
  43         void setShareAddressbook (final Addressbook shareAddressbook);
  44
  45         /**
  46          * Getter for id number
  47          * <p>
  48          * @return Id number
  49          */
  50         Long getShareId ();
  51
  52         /**
  53          * Setter for id number
  54          * <p>
  55          * @param shareId Id number
  56          */
  57         void setShareId (final Long shareId);
  58
  59         /**
  60          * Getter for address book owner instance
  61          * <p>
  62          * @return Address book owner instance
  63          */
  64         User getShareUserOwner ();
  65
  66         /**
  67          * Setter for address book owner instance
  68          * <p>
  69          * @param shareUserOwner Address book owner instance
  70          */
  71         void setShareUserOwner (final User shareUserOwner);
  72
  73         /**
  74          * Getter for address book sharee instance
  75          * <p>
  76          * @return Address book sharee instance
  77          */
  78         User getShareUserSharee ();
  79
  80         /**
  81          * Setter for address book sharee instance
  82          * <p>
  83          * @param shareUserSharer Address book sharee instance
  84          */
  85         void setShareUserSharee (final User shareUserSharer);
  86
  87         /**
  88          * Getter for share creation timestamp
  89          * <p>
  90          * @return Share creation timestamp
  91          */
  92         Calendar getShareCreated ();
  93
  94         /**
  95          * Setter for share creation timestamp
  96          * <p>
  97          * @param shareCreated Share creation timestamp
  98          */
  99         void setShareCreated (final Calendar shareCreated);
 100
 101         @Override
 102         boolean equals (final Object object);
 103
 104         @Override
 105         int hashCode ();
 106 }