src/org/mxchange/jcontactsbusiness/model/headquarter/Headquarter.java

   1 /*
   2  * Copyright (C) 2016 - 2020 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.jcontactsbusiness.model.headquarter;
  18
  19 import java.io.Serializable;
  20 import java.util.Date;
  21 import java.util.List;
  22 import org.mxchange.jcontactsbusiness.model.employee.Employable;
  23 import org.mxchange.jcontactsbusiness.model.opening_time.OpeningTime;
  24 import org.mxchange.jcountry.model.data.Country;
  25 import org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber;
  26 import org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber;
  27 import org.mxchange.jusercore.model.user.User;
  28
  29 /**
  30  * A POJI for headquarter data
  31  * <p>
  32  * @author Roland Häder<roland@mxchange.org>
  33  */
  34 public interface Headquarter extends Comparable<Headquarter>, Serializable {
  35
  36         /**
  37          * Getter for headquarter's city name
  38          * <p>
  39          * @return Headquarter's city name
  40          */
  41         String getHeadquarterCity ();
  42
  43         /**
  44          * Setter for headquarter's city name
  45          * <p>
  46          * @param headquarterCity Headquarter's city name
  47          */
  48         void setHeadquarterCity (final String headquarterCity);
  49
  50         /**
  51          * Getter for headquarter's company name
  52          * <p>
  53          * @return Headquarter's company name
  54          */
  55         String getHeadquarterCompanyName ();
  56
  57         /**
  58          * Setter for headquarter's company name
  59          * <p>
  60          * @param headquarterCompanyName Headquarter's company name
  61          */
  62         void setHeadquarterCompanyName (final String headquarterCompanyName);
  63
  64         /**
  65          * Getter for headquarter's country code
  66          * <p>
  67          * @return Headquarter's country code
  68          */
  69         Country getHeadquarterCountry ();
  70
  71         /**
  72          * Setter for headquarter's country code
  73          * <p>
  74          * @param headquarterCountryCode Headquarter's country code
  75          */
  76         void setHeadquarterCountry (final Country headquarterCountryCode);
  77
  78         /**
  79          * Getter for headquarter's house number
  80          * <p>
  81          * @return Headquarter's house number
  82          */
  83         Short getHeadquarterHouseNumber ();
  84
  85         /**
  86          * Setter for headquarter's house number
  87          * <p>
  88          * @param headquarterHouseNumber Headquarter's house number
  89          */
  90         void setHeadquarterHouseNumber (final Short headquarterHouseNumber);
  91
  92         /**
  93          * Getter for house number's extension
  94          * <p>
  95          * @return House number's extension
  96          */
  97         String getHeadquarterHouseNumberExtension ();
  98
  99         /**
 100          * Setter for house number's extension
 101          * <p>
 102          * @param headquarterHouseNumberExtension House number's extension
 103          */
 104         void setHeadquarterHouseNumberExtension (final String headquarterHouseNumberExtension);
 105
 106         /**
 107          * Getter for headquarter's last house number
 108          * <p>
 109          * @return Headquarter's last house number
 110          */
 111         Short getHeadquarterLastHouseNumber ();
 112
 113         /**
 114          * Setter for headquarter's last house number
 115          * <p>
 116          * @param headquarterLastHouseNumber Headquarter's last house number
 117          */
 118         void setHeadquarterLastHouseNumber (final Short headquarterLastHouseNumber);
 119
 120         /**
 121          * Getter for headquarter's id number
 122          * <p>
 123          * @return Headquarter's id number
 124          */
 125         Long getHeadquarterId ();
 126
 127         /**
 128          * Setter for headquarter's id number
 129          * <p>
 130          * @param headquarterId Headquarter's id number
 131          */
 132         void setHeadquarterId (final Long headquarterId);
 133
 134         /**
 135          * Getter for headquarter's store number
 136          * <p>
 137          * @return Headquarter's store number
 138          */
 139         Short getHeadquarterStore ();
 140
 141         /**
 142          * Setter for headquarter's store number
 143          * <p>
 144          * @param headquarterStore Headquarter's store number
 145          */
 146         void setHeadquarterStore (final Short headquarterStore);
 147
 148         /**
 149          * Getter for headquarter's street name
 150          * <p>
 151          * @return Headquarter's street name
 152          */
 153         String getHeadquarterStreet ();
 154
 155         /**
 156          * Setter for headquarter's street name
 157          * <p>
 158          * @param headquarterStreet Headquarter's street name
 159          */
 160         void setHeadquarterStreet (final String headquarterStreet);
 161
 162         /**
 163          * Getter for headquarter's suite number
 164          * <p>
 165          * @return Headquarter's suite number
 166          */
 167         Short getHeadquarterSuiteNumber ();
 168
 169         /**
 170          * Setter for headquarter's suite number
 171          * <p>
 172          * @param headquarterSuiteNumber Headquarter's suite number
 173          */
 174         void setHeadquarterSuiteNumber (final Short headquarterSuiteNumber);
 175
 176         /**
 177          * Getter for headquarter's ZIP code
 178          * <p>
 179          * @return Headquarter's ZIP code
 180          */
 181         Integer getHeadquarterZipCode ();
 182
 183         /**
 184          * Setter for headquarter's ZIP code
 185          * <p>
 186          * @param headquarterZipCode Headquarter's ZIP code
 187          */
 188         void setHeadquarterZipCode (final Integer headquarterZipCode);
 189
 190         /**
 191          * Getter for headquarter's land-line number
 192          * <p>
 193          * @return Headquarter's land-line number
 194          */
 195         DialableLandLineNumber getHeadquarterLandLineNumber ();
 196
 197         /**
 198          * Setter for headquarter's land-line number
 199          * <p>
 200          * @param headquarterLandLineNumber Headquarter's land-line number
 201          */
 202         void setHeadquarterLandLineNumber (final DialableLandLineNumber headquarterLandLineNumber);
 203
 204         /**
 205          * Getter for headquarter's fax number
 206          * <p>
 207          * @return Headquarter's fax number
 208          */
 209         DialableFaxNumber getHeadquarterFaxNumber ();
 210
 211         /**
 212          * Setter for headquarter's fax number
 213          * <p>
 214          * @param headquarterFaxNumber Headquarter's fax number
 215          */
 216         void setHeadquarterFaxNumber (final DialableFaxNumber headquarterFaxNumber);
 217
 218         /**
 219          * Getter for user owner instance
 220          * <p>
 221          * @return User owner instance
 222          */
 223         User getHeadquarterUserOwner ();
 224
 225         /**
 226          * Setter for user owner instance
 227          * <p>
 228          * @param headquarterUserOwner User owner instance
 229          */
 230         void setHeadquarterUserOwner (final User headquarterUserOwner);
 231
 232         /**
 233          * Getter for branch office owning employee
 234          * <p>
 235          * @return Owning employee
 236          */
 237         Employable getHeadquarterContactEmployee ();
 238
 239         /**
 240          * Setter for branch office contact person
 241          * <p>
 242          * @param branchContactEmployee Contact person
 243          */
 244         void setHeadquarterContactEmployee (final Employable branchContactEmployee);
 245
 246         /**
 247          * Getter for opening times for this branch office
 248          * <p>
 249          * @return Opening times
 250          */
 251         List<OpeningTime> getHeadquarterOpeningTimes ();
 252
 253         /**
 254          * Setter for opening times for this branch office
 255          * <p>
 256          * @param branchOpeningTimes Opening times
 257          */
 258         void setHeadquarterOpeningTimes (final List<OpeningTime> branchOpeningTimes);
 259
 260         /**
 261          * Getter for headquarter's email address
 262          * <p>
 263          * @return Headquarter's email address
 264          */
 265         String getHeadquarterEmailAddress ();
 266
 267         /**
 268          * Setter for headquarter's email address
 269          * <p>
 270          * @param headquarterEmailAddress Headquarter's email address
 271          */
 272         void setHeadquarterEmailAddress (final String headquarterEmailAddress);
 273
 274         /**
 275          * Getter for timestamp when this entry has been created
 276          * <p>
 277          * @return Timestamp when this entry has been created
 278          */
 279         Date getHeadquarterCreated ();
 280
 281         /**
 282          * Setter for timestamp when this entry has been created
 283          * <p>
 284          * @param headquarterCreated Timestamp when this entry has been created
 285          */
 286         void setHeadquarterCreated (final Date headquarterCreated);
 287
 288         @Override
 289         boolean equals (final Object object);
 290
 291         @Override
 292         int hashCode ();
 293
 294 }