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

   1 /*
   2  * Copyright (C) 2016 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
  23 /**
  24  * An interface for user beans
  25  * <p>
  26  * @author Roland Haeder<roland@mxchange.org>
  27  */
  28 @Remote
  29 public interface UserSessionBeanRemote extends Serializable {
  30
  31         /**
  32          * Returns a list with all public and member-visible users. Members are
  33          * logged-in users. ;-)
  34          * <p>
  35          * @return A list of public and member-visible users
  36          */
  37         List<User> allMemberPublicVisibleUsers ();
  38
  39         /**
  40          * Returns a list of all public user profiles
  41          * <p>
  42          * @return A list of all public user profiles
  43          */
  44         List<User> allPublicUsers ();
  45
  46         /**
  47          * Fills given user instance with all available data
  48          * <p>
  49          * @param user Initial User instance
  50          * <p>
  51          * @return Prepared User instance
  52          */
  53         User fillUserData (final User user);
  54
  55         /**
  56          * Some "getter" for a full user name list
  57          * <p>
  58          * @return User name list
  59          */
  60         List<String> getUserNameList ();
  61
  62         /**
  63          * Some "getter" for a full email address list
  64          * <p>
  65          * @return User name list
  66          */
  67         List<String> getEmailAddressList ();
  68
  69         /**
  70          * Checks if given user id exists
  71          * <p>
  72          * @param userId User id to check
  73          * <p>
  74          * @return Whether the user id exists
  75          */
  76         boolean ifUserIdExists (final Long userId);
  77
  78         /**
  79          * Checks if the the given user's name is already registered
  80          * <p>
  81          * @param user User instance
  82          * <p>
  83          * @return Whether the user is already registered
  84          */
  85         boolean isUserNameReqistered (final User user);
  86
  87         /**
  88          * Checks if the the given user's email address is already registered
  89          * <p>
  90          * @param user User instance
  91          * <p>
  92          * @return Whether the user is already registered
  93          */
  94         boolean isEmailAddressReqistered (final User user);
  95
  96         /**
  97          * Updates given user instance in database
  98          * <p>
  99          * @param user User instance to update
 100          */
 101         void updateUserPersonalData (final User user);
 102
 103 }