src/org/mxchange/jaddressbook/model/addressbook/Addressbook.java

   1 /*
   2  * Copyright (C) 2016 - 2024 Free Software Foundation
   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.jaddressbook.model.addressbook;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import org.mxchange.jaddressbook.model.addressbook.status.AddressbokStatus;
  22 import org.mxchange.jusercore.model.user.User;
  23
  24 /**
  25  * A POJI for addressbooks
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 public interface Addressbook extends Comparable<Addressbook>, Serializable {
  30
  31         /**
  32          * Getter for id number
  33          * <p>
  34          * @return Id number
  35          */
  36         Long getAddressbookId ();
  37
  38         /**
  39          * Setter for id number
  40          * <p>
  41          * @param addressbookId Id number
  42          */
  43         void setAddressbookId (final Long addressbookId);
  44
  45         /**
  46          * Getter for addressbook created timestamp
  47          * <p>
  48          * @return Addressbook created timestamp
  49          */
  50         Date getAddressbookEntryCreated ();
  51
  52         /**
  53          * Setter for addressbook created timestamp
  54          * <p>
  55          * @param addressbookEntryCreated Addressbook created timestamp
  56          */
  57         void setAddressbookEntryCreated (final Date addressbookEntryCreated);
  58
  59         /**
  60          * Getter for addressbook updated timestamp
  61          * <p>
  62          * @return Addressbook updated timestamp
  63          */
  64         Date getAddressbookEntryUpdated ();
  65
  66         /**
  67          * Setter for addressbook updated timestamp
  68          * <p>
  69          * @param addressbookEntryUpdated Addressbook updated timestamp
  70          */
  71         void setAddressbookEntryUpdated (final Date addressbookEntryUpdated);
  72
  73         /**
  74          * Getter for addressbook's name
  75          * <p>
  76          * @return Addressbook's name
  77          */
  78         String getAddressbookName ();
  79
  80         /**
  81          * Setter for addressbook's name
  82          * <p>
  83          * @param addressbookName Addressbook's name
  84          */
  85         void setAddressbookName (final String addressbookName);
  86
  87         /**
  88          * Getter for addressbook status
  89          * <p>
  90          * @return Addressbook status
  91          */
  92         AddressbokStatus getAddressbookStatus ();
  93
  94         /**
  95          * Setter for addressbook status
  96          * <p>
  97          * @param addressbookStatus Addressbook status
  98          */
  99         void setAddressbookStatus (final AddressbokStatus addressbookStatus);
 100
 101         /**
 102          * Getter for addressbook's user (owner)
 103          * <p>
 104          * @return Addressbook's user (owner)
 105          */
 106         User getAddressbookUser ();
 107
 108         /**
 109          * Setter for addressbook's user (owner)
 110          * <p>
 111          * @param addressbookUser Addressbook's user (owner)
 112          */
 113         void setAddressbookUser (final User addressbookUser);
 114
 115         /**
 116          * Getter for last locked timestamp
 117          * <p>
 118          * @return Last locked timestamp
 119          */
 120         Date getAddressbookLastLocked ();
 121
 122         /**
 123          * Setter for last locked timestamp
 124          * <p>
 125          * @param addressbookLastLocked Last locked timestamp
 126          */
 127         void setAddressbookLastLocked (final Date addressbookLastLocked);
 128
 129         /**
 130          * Getter for last locked reason
 131          * <p>
 132          * @return Last locked reason
 133          */
 134         String getAddressbookLastLockedReason ();
 135
 136         /**
 137          * Getter for last locked reason
 138          * <p>
 139          * @param addressbookLastLockedReason Last locked reason
 140          */
 141         void setAddressbookLastLockedReason (final String addressbookLastLockedReason);
 142
 143         @Override
 144         boolean equals (final Object object);
 145
 146         @Override
 147         int hashCode ();
 148
 149 }