src/org/mxchange/jusercore/model/user/UserSessionBeanRemote.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   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;
  18
  19 import java.io.Serializable;
  20 import java.util.List;
  21 import javax.ejb.Remote;
  22 import org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException;
  23 import org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException;
  24
  25 /**
  26  * An interface for user beans
  27  * <p>
  28  * @author Roland Haeder<roland@mxchange.org>
  29  */
  30 @Remote
  31 public interface UserSessionBeanRemote extends Serializable {
  32
  33         /**
  34          * Fills given user instance with all available data
  35          * <p>
  36          * @param user Initial User instance
  37          * @return Prepared User instance
  38          */
  39         public User fillUserData (final User user);
  40
  41         /**
  42          * Some "getter" for a full user name list
  43          *
  44          * @return User name list
  45          */
  46         public List<String> getUserNameList ();
  47
  48         /**
  49          * Some "getter" for a full email address list
  50          *
  51          * @return User name list
  52          */
  53         public List<String> getEmailAddressList ();
  54
  55         /**
  56          * Checks if the the given user's name is already registered
  57          * <p>
  58          * @param user User instance
  59          * @return Whether the user is already registered
  60          */
  61         public boolean isUserNameReqistered (final User user);
  62
  63         /**
  64          * Checks if the the given user's email address is already registered
  65          * <p>
  66          * @param user User instance
  67          * @return Whether the user is already registered
  68          */
  69         public boolean isEmailAddressReqistered (final User user);
  70
  71         /**
  72          * Registers the user.
  73          * <p>
  74          * @param user Initial customer instance
  75          * @return Prepared Customer instance
  76          * @throws org.mxchange.jusercore.exceptions.UserNameAlreadyRegisteredException If the user's user name is already registered.
  77          * @throws org.mxchange.jusercore.exceptions.EmailAddressAlreadyRegisteredException If the user's email address is already registered.
  78          */
  79         public User registerUser (final User user) throws UserNameAlreadyRegisteredException, EmailAddressAlreadyRegisteredException;
  80 }