2 * Copyright (C) 2016 Roland Haeder
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Affero General Public License as
6 * published by the Free Software Foundation, either version 3 of the
7 * License, or (at your option) any later version.
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 Affero General Public License for more details.
14 * You should have received a copy of the GNU Affero General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.pizzaapplication.beans.user;
19 import java.io.Serializable;
20 import java.util.Date;
21 import java.util.List;
22 import org.mxchange.jcontacts.contact.gender.Gender;
23 import org.mxchange.jcountry.data.Country;
24 import org.mxchange.jphone.phonenumbers.smsprovider.SmsProvider;
25 import org.mxchange.jusercore.exceptions.UserNotFoundException;
26 import org.mxchange.jusercore.model.user.User;
27 import org.mxchange.jusercore.model.user.profilemodes.ProfileMode;
30 * An interface for user beans
32 * @author Roland Haeder<roland@mxchange.org>
34 public interface PizzaAdminUserWebSessionController extends Serializable {
37 * Tries to lookup user by given id number. If the user is not found or the
38 * account status is not CONFIRMED proper exceptions are thrown.
40 * @param userId User id
42 * @return User instance
44 * @throws UserNotFoundException If the user is not found
46 User lookupUserById (final Long userId) throws UserNotFoundException;
51 * @return A list of all public user profiles
53 List<User> allUsers ();
56 * Checks whether users are registered
58 * @return Whether users are registered
63 * Getter for birth day
70 * Setter for birth day
72 * @param birthday Birth day
74 void setBirthday (final Date birthday);
77 * Getter for ellphone number's carrier
79 * @return Cellphone number's carrier
81 SmsProvider getCellphoneCarrier ();
84 * Setter for cellphone number's carrier prefix
86 * @param cellphoneCarrier Cellphone number's carrier prefix
88 void setCellphoneCarrier (final SmsProvider cellphoneCarrier);
91 * Getter for ellphone number
93 * @return Cellphone number
95 Long getCellphoneNumber ();
98 * Setter for ellphone number
100 * @param cellphoneNumber Cellphone number
102 void setCellphoneNumber (final Long cellphoneNumber);
114 * @param city the city to set
116 void setCity (final String city);
119 * Getter for comments
123 String getComment ();
128 * @param comment Comments
130 void setComment (final String comment);
133 * Getter for country instance
135 * @return Country instance
137 Country getCountry ();
140 * Setter for country instance
142 * @param country Country instance
144 void setCountry (final Country country);
147 * Getter for email address
149 * @return Email address
151 String getEmailAddress ();
154 * Setter for email address
156 * @param emailAddress Email address
158 void setEmailAddress (final String emailAddress);
163 * @return the familyName
165 String getFamilyName ();
170 * @param familyName the familyName to set
172 void setFamilyName (final String familyName);
175 * Getter for fax number's area code
177 * @return Fax number's area code
179 Integer getFaxAreaCode ();
182 * Setter for fax number's area code
184 * @param faxAreaCode Fax number's area code
186 void setFaxAreaCode (final Integer faxAreaCode);
189 * Getter for fax's country instance
191 * @return Fax' country instance
193 Country getFaxCountry ();
196 * Setter for fax's country instance
198 * @param faxCountry Fax' country instance
200 void setFaxCountry (final Country faxCountry);
203 * Getter for fax number
207 Long getFaxNumber ();
210 * Setter for fax number
212 * @param faxNumber Fax number
214 void setFaxNumber (final Long faxNumber);
219 * @return the first name
221 String getFirstName ();
226 * @param firstName the first name to set
228 void setFirstName (final String firstName);
231 * Gender of the contact
238 * Gender of the contact
240 * @param gender the gender to set
242 void setGender (final Gender gender);
247 * @return the houseNumber
249 Short getHouseNumber ();
254 * @param houseNumber the houseNumber to set
256 void setHouseNumber (final Short houseNumber);
259 * Getter for phone number's area code
261 * @return Phone number's area code
263 Integer getPhoneAreaCode ();
266 * Setter for phone number's area code
268 * @param phoneAreaCode Phone number's area code
270 void setPhoneAreaCode (final Integer phoneAreaCode);
273 * Getter for phone number's country instance
275 * @return Phone number's country instance
277 Country getPhoneCountry ();
280 * Setter for phone number's country instance
282 * @param phoneCountry Phone number's country instance
284 void setPhoneCountry (final Country phoneCountry);
287 * Getter for phone number
289 * @return Phone number
291 Long getPhoneNumber ();
294 * Setter for phone number
296 * @param phoneNumber Phone number
298 void setPhoneNumber (final Long phoneNumber);
310 * @param street the street to set
312 void setStreet (final String street);
324 * @param userId User id
326 void setUserId (final Long userId);
329 * Getter for user name
333 String getUserName ();
336 * Setter for user name
338 * @param userName User name
340 void setUserName (final String userName);
343 * Getter for unencrypted user password
345 * @return Unencrypted user password
347 String getUserPassword ();
350 * Setter for unencrypted user password
352 * @param userPassword Unencrypted user password
354 void setUserPassword (final String userPassword);
357 * Getter for unencrypted user password repeated
359 * @return Unencrypted user password repeated
361 String getUserPasswordRepeat ();
364 * Setter for unencrypted user password repeated
366 * @param userPasswordRepeat Unencrypted user password repeated
368 void setUserPasswordRepeat (final String userPasswordRepeat);
371 * Getter for user profile mode
373 * @return User profile mode
375 ProfileMode getUserProfileMode ();
378 * Setter for user profile mode
380 * @param userProfileMode User profile mode
382 void setUserProfileMode (final ProfileMode userProfileMode);
387 * @return the zipCode
389 Integer getZipCode ();
394 * @param zipCode the zipCode to set
396 void setZipCode (final Integer zipCode);