src/org/mxchange/jusercore/model/user/activity/LogableUserActivity.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.activity;
  18
  19 import java.io.Serializable;
  20 import java.util.Calendar;
  21 import org.mxchange.jcontacts.contact.gender.Gender;
  22 import org.mxchange.jusercore.model.user.User;
  23
  24 /**
  25  * POJI for logable user activity
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 public interface LogableUserActivity extends Serializable {
  30
  31         /**
  32          * Getter for activity id
  33          * <p>
  34          * @return Activity id
  35          */
  36         Long getActivityId ();
  37
  38         /**
  39          * Getter for activity id
  40          * <p>
  41          * @param activityId Activity id
  42          */
  43         void setActivityId (final Long activityId);
  44
  45         /**
  46          * Getter for activity message (optional)
  47          * <p>
  48          * @return Activity message
  49          */
  50         String getActivityMessage ();
  51
  52         /**
  53          * Setter for activity message (optional)
  54          * <p>
  55          * @param activityMessage Activity message
  56          */
  57         void setActivityMessage (final String activityMessage);
  58
  59         /**
  60          * Getter for principal name
  61          * <p>
  62          * @return Principal name
  63          */
  64         String getActivityPrincipalName ();
  65
  66         /**
  67          * Setter for principal name
  68          * <p>
  69          * @param activityPrincipalName Principal name
  70          */
  71         void setActivityPrincipalName (final String activityPrincipalName);
  72
  73         /**
  74          * Getter for activity timestamp
  75          * <p>
  76          * @return Activity timestamp
  77          */
  78         Calendar getActivityTimestamp ();
  79
  80         /**
  81          * Setter for activity timestamp
  82          * <p>
  83          * @param activityTimestamp Activity timestamp
  84          */
  85         void setActivityTimestamp (final Calendar activityTimestamp);
  86
  87         /**
  88          * Getter for activity type
  89          * <p>
  90          * @return Activity type
  91          */
  92         String getActivityType ();
  93
  94         /**
  95          * Setter for activity type
  96          * <p>
  97          * @param activityType Activity type
  98          */
  99         void setActivityType (final String activityType);
 100
 101         /**
 102          * Getter for activity user (who did it)
 103          * <p>
 104          * @return User who did activity
 105          */
 106         User getActivityUser ();
 107
 108         /**
 109          * Setter for activity user (who did it)
 110          * <p>
 111          * @param activityUser User who did activity
 112          */
 113         void setActivityUser (final User activityUser);
 114
 115         /**
 116          * Getter for user name
 117          * <p>
 118          * @return User name
 119          */
 120         String getActivityUserName ();
 121
 122         /**
 123          * Setter for user name
 124          * <p>
 125          * @param activityUserName User name
 126          */
 127         void setActivityUserName (final String activityUserName);
 128
 129         /**
 130          * Getter for contact family name
 131          * <p>
 132          * @return Contact family name
 133          */
 134         String getActivityContactFamilyName ();
 135
 136         /**
 137          * Setter for contact family name
 138          * <p>
 139          * @param activityContactFamilyName Contact family name
 140          */
 141         void setActivityContactFamilyName (final String activityContactFamilyName);
 142
 143         /**
 144          * Getter for contact first name
 145          * <p>
 146          * @return Contact first name
 147          */
 148         String getActivityContactFirstName ();
 149
 150         /**
 151          * Setter for contact first name
 152          * <p>
 153          * @param activityContactFirstName Contact first name
 154          */
 155         void setActivityContactFirstName (final String activityContactFirstName);
 156
 157         /**
 158          * Getter for contact gender
 159          * <p>
 160          * @return Contact gender
 161          */
 162         Gender getActivityContactGender ();
 163
 164         /**
 165          * Setter for contact gender
 166          * <p>
 167          * @param activityContactGender Contact gender
 168          */
 169         void setActivityContactGender (final Gender activityContactGender);
 170
 171         @Override
 172         boolean equals (final Object object);
 173
 174         @Override
 175         int hashCode ();
 176
 177 }