src/org/mxchange/jusercore/model/user/email_address/UserEmailChangeSessionBeanRemote.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.jusercore.model.user.email_address;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Remote;
  22 import org.mxchange.jusercore.model.email_address.ChangeableEmailAddress;
  23
  24 /**
  25  * A remote interface for changing email addresses
  26  * <p>
  27  * @author Roland Häder<roland@mxchange.org>
  28  */
  29 @Remote
  30 public interface UserEmailChangeSessionBeanRemote extends Serializable {
  31
  32         /**
  33          * Returns a list of all queued email address changes.
  34          * <p>
  35          * @return A list of all queued email address changes
  36          */
  37         List<ChangeableEmailAddress> fetchAllQueuedAddressChanges ();
  38
  39         /**
  40          * "Enqueues" given email change object
  41          * <p>
  42          * @param emailChange Email change instance to insert
  43          * @param baseUrl     Base URL
  44          */
  45         void enqueueEmailAddressForChange (final ChangeableEmailAddress emailChange, final String baseUrl);
  46
  47         /**
  48          * Updates given user's email address.
  49          * <p>
  50          * @param emailChange Email change instance to mark as used
  51          */
  52         void updateEmailAddress (final ChangeableEmailAddress emailChange);
  53
  54 }