View Javadoc
1   /*
2    * Copyright (c) 2002-2021, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.newsletter.business;
35  
36  import java.sql.Timestamp;
37  
38  /**
39   * This class represents business objects Subscriber
40   */
41  public class Subscriber
42  {
43      /////////////////////////////////////////////////////////////////////////////////
44      // Constants
45      private boolean _bConfirmed;
46      private int _nId;
47      private String _strEmail;
48      private Timestamp _dDateSubscription;
49  
50      /**
51       * Returns the subscriber's identifier
52       *
53       * @return the subscriber's identifier
54       */
55      public int getId( )
56      {
57          return _nId;
58      }
59  
60      /**
61       * Sets the subscriber's identifier
62       *
63       * @param nId
64       *            the subscriber's identifier
65       */
66      public void setId( int nId )
67      {
68          _nId = nId;
69      }
70  
71      /**
72       * Returns the subscriber's email
73       *
74       * @return the subscriber's email
75       */
76      public String getEmail( )
77      {
78          return _strEmail;
79      }
80  
81      /**
82       * Sets the subscriber's email (in lower case )
83       *
84       * @param strEmail
85       *            the subscriber's email
86       */
87      public void setEmail( String strEmail )
88      {
89          _strEmail = strEmail.toLowerCase( );
90      }
91  
92      /**
93       * Returns the date of the subscription
94       *
95       * @return the subscription's date
96       */
97      public Timestamp getDateSubscription( )
98      {
99          return _dDateSubscription;
100     }
101 
102     /**
103      * Sets the subscription's date
104      *
105      * @param dDateSubscription
106      *            the subscription's date
107      */
108     public void setDateSubscription( Timestamp dDateSubscription )
109     {
110         _dDateSubscription = dDateSubscription;
111     }
112 
113     /**
114      * Return <b>true</b> if user confirmed his subscription.
115      * 
116      * @return <b>true</b> if user confirmed his subscription, <b>false</b> otherwise
117      */
118     public boolean getConfirmed( )
119     {
120         return _bConfirmed;
121     }
122 
123     /**
124      * Set to <b>true</b> if user confirmed his subscription
125      * 
126      * @param bConfirmed
127      *            the new confirmed value.
128      */
129     public void setConfirmed( boolean bConfirmed )
130     {
131         _bConfirmed = bConfirmed;
132     }
133 }