src/org/mxchange/jusercore/model/user/activity/LogableUserActivity.java

   1 /*
   2  * Copyright (C) 2016 Cho-Time GmbH
   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.jusercore.model.user.User;
  22
  23 /**
  24  * POJI for logable user activity
  25  * <p>
  26  * @author Roland Haeder<rhaeder@cho-time.de>
  27  */
  28 public interface LogableUserActivity extends Serializable {
  29
  30         /**
  31          * Getter for activity id
  32          * <p>
  33          * @return Activity id
  34          */
  35         Long getActivityId ();
  36
  37         /**
  38          * Getter for activity id
  39          * <p>
  40          * @param activityId Activity id
  41          */
  42         void setActivityId (final Long activityId);
  43
  44         /**
  45          * Getter for activity message (optional)
  46          * <p>
  47          * @return Activity message
  48          */
  49         String getActivityMessage ();
  50
  51         /**
  52          * Setter for activity message (optional)
  53          * <p>
  54          * @param activityMessage Activity message
  55          */
  56         void setActivityMessage (final String activityMessage);
  57
  58         /**
  59          * Getter for activity timestamp
  60          * <p>
  61          * @return Activity timestamp
  62          */
  63         Calendar getActivityTimestamp ();
  64
  65         /**
  66          * Setter for activity timestamp
  67          * <p>
  68          * @param activityTimestamp Activity timestamp
  69          */
  70         void setActivityTimestamp (final Calendar activityTimestamp);
  71
  72         /**
  73          * Getter for activity type
  74          * <p>
  75          * @return Activity type
  76          */
  77         String getActivityType ();
  78
  79         /**
  80          * Setter for activity type
  81          * <p>
  82          * @param activityType Activity type
  83          */
  84         void setActivityType (final String activityType);
  85
  86         /**
  87          * Getter for activity user (who did it)
  88          * <p>
  89          * @return User who did activity
  90          */
  91         User getActivityUser ();
  92
  93         /**
  94          * Setter for activity user (who did it)
  95          * <p>
  96          * @param activityUser User who did activity
  97          */
  98         void setActivityUser (final User activityUser);
  99
 100         @Override
 101         boolean equals (final Object object);
 102
 103         @Override
 104         int hashCode ();
 105
 106 }