src/org/mxchange/jcontactsbusiness/headquarters/HeadQuartersData.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   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.jcontactsbusiness.headquarters;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import org.mxchange.jcountry.data.Country;
  22 import org.mxchange.jphone.phonenumbers.fax.DialableFaxNumber;
  23 import org.mxchange.jphone.phonenumbers.landline.DialableLandLineNumber;
  24 import org.mxchange.jusercore.model.user.User;
  25
  26 /**
  27  * A POJI for headquarters data
  28  * <p>
  29  * @author Roland Häder<roland@mxchange.org>
  30  */
  31 public interface HeadQuartersData extends Serializable {
  32
  33         /**
  34          * Getter for headquarters' city name
  35          * <p>
  36          * @return Headquarters' city name
  37          */
  38         String getHeadquartersCity ();
  39
  40         /**
  41          * Setter for headquarters' city name
  42          * <p>
  43          * @param headquartersCity Headquarters' city name
  44          */
  45         void setHeadquartersCity (final String headquartersCity);
  46
  47         /**
  48          * Getter for headquarters' country code
  49          * <p>
  50          * @return Headquarters' country code
  51          */
  52         Country getHeadquartersCountry ();
  53
  54         /**
  55          * Setter for headquarters' country code
  56          * <p>
  57          * @param headquartersCountryCode Headquarters' country code
  58          */
  59         void setHeadquartersCountry (final Country headquartersCountryCode);
  60
  61         /**
  62          * Getter for headquarters' house number
  63          * <p>
  64          * @return Headquarters' house number
  65          */
  66         Short getHeadquartersHouseNumber ();
  67
  68         /**
  69          * Setter for headquarters' house number
  70          * <p>
  71          * @param headquartersHouseNumber Headquarters' house number
  72          */
  73         void setHeadquartersHouseNumber (final Short headquartersHouseNumber);
  74
  75         /**
  76          * Getter for headquarters' id number
  77          * <p>
  78          * @return Headquarters' id number
  79          */
  80         Long getHeadquartersId ();
  81
  82         /**
  83          * Setter for headquarters' id number
  84          * <p>
  85          * @param headquartersId Headquarters' id number
  86          */
  87         void setHeadquartersId (final Long headquartersId);
  88
  89         /**
  90          * Getter for headquarters' store number
  91          * <p>
  92          * @return Headquarters' store number
  93          */
  94         Short getHeadquartersStore ();
  95
  96         /**
  97          * Setter for headquarters' store number
  98          * <p>
  99          * @param headquartersStore Headquarters' store number
 100          */
 101         void setHeadquartersStore (final Short headquartersStore);
 102
 103         /**
 104          * Getter for headquarters' street name
 105          * <p>
 106          * @return Headquarters' street name
 107          */
 108         String getHeadquartersStreet ();
 109
 110         /**
 111          * Setter for headquarters' street name
 112          * <p>
 113          * @param headquartersStreet Headquarters' street name
 114          */
 115         void setHeadquartersStreet (final String headquartersStreet);
 116
 117         /**
 118          * Getter for headquarters' suite number
 119          * <p>
 120          * @return Headquarters' suite number
 121          */
 122         Short getHeadquartersSuiteNumber ();
 123
 124         /**
 125          * Setter for headquarters' suite number
 126          * <p>
 127          * @param headquartersSuiteNumber Headquarters' suite number
 128          */
 129         void setHeadquartersSuiteNumber (final Short headquartersSuiteNumber);
 130
 131         /**
 132          * Getter for headquarters' ZIP code
 133          * <p>
 134          * @return Headquarters' ZIP code
 135          */
 136         Integer getHeadquartersZipCode ();
 137
 138         /**
 139          * Setter for headquarters' ZIP code
 140          * <p>
 141          * @param headquartersZipCode Headquarters' ZIP code
 142          */
 143         void setHeadquartersZipCode (final Integer headquartersZipCode);
 144
 145         /**
 146          * Getter for headquarters' phone number
 147          * <p>
 148          * @return Headquarters' phone number
 149          */
 150         DialableLandLineNumber getHeadquartersPhoneNumber ();
 151
 152         /**
 153          * Setter for headquarters' phone number
 154          * <p>
 155          * @param headquartersPhoneNumber Headquarters' phone number
 156          */
 157         void setHeadquartersPhoneNumber (final DialableLandLineNumber headquartersPhoneNumber);
 158
 159         /**
 160          * Getter for headquarters' fax number
 161          * <p>
 162          * @return Headquarters' fax number
 163          */
 164         DialableFaxNumber getHeadquartersFaxNumber ();
 165
 166         /**
 167          * Setter for headquarters' fax number
 168          * <p>
 169          * @param headquartersFaxNumber Headquarters' fax number
 170          */
 171         void setHeadquartersFaxNumber (final DialableFaxNumber headquartersFaxNumber);
 172
 173         /**
 174          * Getter for user owner instance
 175          * <p>
 176          * @return User owner instance
 177          */
 178         User getHeadquartersUserOwner ();
 179
 180         /**
 181          * Setter for user owner instance
 182          * <p>
 183          * @param headquartersUserOwner User owner instance
 184          */
 185         void setHeadquartersUserOwner (final User headquartersUserOwner);
 186
 187         /**
 188          * Getter for timestamp when this entry has been created
 189          * <p>
 190          * @return Timestamp when this entry has been created
 191          */
 192         Calendar getHeadquartersCreated ();
 193
 194         /**
 195          * Setter for timestamp when this entry has been created
 196          * <p>
 197          * @param headquartersCreated Timestamp when this entry has been created
 198          */
 199         void setHeadquartersCreated (final Calendar headquartersCreated);
 200
 201         @Override
 202         boolean equals (final Object object);
 203
 204         @Override
 205         int hashCode ();
 206 }