2 * Copyright (C) 2016, 2017 Roland Häder
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.contact;
19 import java.io.Serializable;
20 import java.util.List;
21 import org.mxchange.jcontacts.contact.Contact;
22 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;
25 * An interface for user beans
27 * @author Roland Häder<roland@mxchange.org>
29 public interface PizzaContactWebSessionController extends Serializable {
32 * Minimum password length
34 public static final Integer MINIMUM_PASSWORD_LENGTH = 5;
37 * Getter for email address
39 * @return Email address
41 String getEmailAddress ();
44 * Clears both email address field
46 void clearEmailAddresses ();
49 * Returns a list of all found contacts
51 * @return A list of all contacts.
53 List<Contact> allContacts ();
56 * Updates all data from bean in given contact instance
58 * @param userContact Contact instance to update
60 void updateContactDataFromController (final Contact userContact);
63 * Tries to lookup contact by given id number. If the user is not found a
64 * proper exceptions are thrown.
66 * @param contactId Contact id
68 * @return Contact instance
70 * @throws ContactNotFoundException If the user is not found
72 Contact lookupContactById (final Long contactId) throws ContactNotFoundException;
75 * Creates an instance from all properties
77 * @return A contact instance
79 Contact createContactInstance ();
82 * Getter for controller type
84 * @return controller type
86 String getControllerType ();
89 * Setter for controller type
91 * @param controllerType Controller type
93 * @deprecated Don't use this method.
96 void setControllerType (final String controllerType);
99 * Checks whether contact instance's email address is used
101 * @param contact Contact instance's email address to check
103 * @return Whether it is already used
105 boolean isEmailAddressRegistered (final Contact contact);
108 * Checks whether all required personal data is set
110 * @return Whether the required personal data is set
112 boolean isRequiredPersonalDataSet ();
115 * Checks whether all required personal data is set for changing them
117 * @return Whether the required personal data is set
119 boolean isRequiredChangePersonalDataSet ();
122 * Checks whether same email addresses have been entered
124 * @return Whether same email addresses have been entered
126 boolean isSameEmailAddressEntered ();
129 * Changes logged-in user's personal data if the current password matches
130 * and TAC + privacy statement has been accepted.
132 * @return New target page
134 String doChangePersonalContactData ();
137 * Returns a list of all selectable contacts for user creation. Contacts
138 * from already existing users are excluded in this list.
140 * @return A list of all selectable contacts
142 List<Contact> selectableContacts ();