git.mxchange.org Git - addressbook-war.git/blob

   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 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.
   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 Affero General Public License for more details.
  13  *
  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/>.
  16  */
  17 package org.mxchange.addressbook.beans.user.email_address;
  18
  19 import java.io.Serializable;
  20
  21 /**
  22  * An interface for an email change controller
  23  * <p>
  24  * @author Roland Häder<roland@mxchange.org>
  25  */
  26 public interface AddressbookEmailChangeWebSessionController extends Serializable {
  27
  28         /**
  29          * Getter for email address 1 (changing)
  30          * <p>
  31          * @return Email address
  32          */
  33         String getEmailAddress ();
  34
  35         /**
  36          * Setter for email address 1 (changing)
  37          * <p>
  38          * @param emailAddress Email address 1
  39          */
  40         void setEmailAddress (final String emailAddress);
  41
  42         /**
  43          * Getter for email address 2 (repeat changing)
  44          * <p>
  45          * @return Email address 2
  46          */
  47         String getEmailAddressRepeat ();
  48
  49         /**
  50          * Setter for email address 2 (repeat changing)
  51          * <p>
  52          * @param emailAddressRepeat Email address 2
  53          */
  54         void setEmailAddressRepeat (final String emailAddressRepeat);
  55
  56         /**
  57          * Checks whether all required are set for changing email address
  58          * <p>
  59          * @return Whether the required personal data is set
  60          */
  61         boolean isRequiredChangeEmailAddressSet ();
  62
  63         /**
  64          * Changes logged-in user's email address if the current password matches.
  65          * <p>
  66          * @return New target page
  67          */
  68         String doUserChangeEmailAddress ();
  69
  70 }