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