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.jjobs.beans.contact;
19 import java.io.Serializable;
20 import java.util.List;
21 import org.mxchange.jcontacts.exceptions.ContactNotFoundException;
22 import org.mxchange.jcontacts.model.contact.Contact;
25 * An interface for user beans
27 * @author Roland Häder<roland@mxchange.org>
29 public interface JobsContactWebRequestController 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 * Creates an instance from all properties
65 * @return A contact instance
67 Contact createContactInstance ();
70 * Getter for controller type
72 * @return controller type
74 String getControllerType ();
77 * Setter for controller type
79 * @param controllerType Controller type
81 * @deprecated Don't use this method.
84 void setControllerType (final String controllerType);
87 * Checks whether contact instance's email address is used
89 * @param contact Contact instance's email address to check
91 * @return Whether it is already used
93 boolean isEmailAddressRegistered (final Contact contact);
96 * Checks whether all required personal data is set
98 * @return Whether the required personal data is set
100 boolean isRequiredPersonalDataSet ();
103 * Checks whether all required personal data is set for changing them
105 * @return Whether the required personal data is set
107 boolean isRequiredChangePersonalDataSet ();
110 * Checks whether same email addresses have been entered
112 * @return Whether same email addresses have been entered
114 boolean isSameEmailAddressEntered ();
117 * Changes logged-in user's personal data if the current password matches
118 * and TAC + privacy statement has been accepted.
120 * @return New target page
122 String doChangePersonalContactData ();
125 * Returns a contact instance which has the given id number.
127 * @param contactId Contact id
129 * @return Contact instance
131 * @throws ContactNotFoundException If the contact was not found
133 Contact findContactById (final Long contactId) throws ContactNotFoundException;
136 * Checks whether the given email address is already registered. The email
137 * address should be validated by EmailAddressValidator before calling this
140 * @param emailAddress Email address to check
142 * @return Whether the email address is already registered
144 boolean isEmailAddressRegistered (final String emailAddress);