2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shale.usecases.model;
19  
20  import java.util.Date;
21  
22  /***
23   * <p>Model interface representing a user of the Use Cases application system.</p>
24   *
25   * $Id: User.java 464373 2006-10-16 04:21:54Z rahul $
26   */
27  public interface User {
28      
29  
30      // -------------------------------------------------------------- Properties
31  
32  
33      /***
34       * <p>Return the category identifiers of the message categories selected
35       * by this user.</p>
36       */
37      public int[] getCategories();
38  
39  
40      /***
41       * <p>Set the category identifiers of the message categories selected
42       * by this user.</p>
43       *
44       * @param categories The new category identifiers
45       */
46      public void setCategories(int categories[]);
47  
48  
49      /***
50       * <p>Return the flag indicating that this user's email address has
51       * been confirmed.</p>
52       */
53      public boolean isConfirmed();
54  
55  
56      /***
57       * <p>Set the flag indicating that this user's email address has
58       * been confirmed.</p>
59       *
60       * @param confirmed The new confirmed flag
61       */
62      public void setConfirmed(boolean confirmed);
63  
64  
65      /***
66       * <p>Return the "initially created" timestamp for this user.</p>
67       */
68      public Date getCreated();
69  
70  
71      /***
72       * <p>Set the "initially created" timestamp for this user.</p>
73       *
74       * @param created The new initially created timestamp
75       */
76      public void setCreated(Date created);
77  
78  
79      /***
80       * <p>Return the email address of this user.</p>
81       */
82      public String getEmailAddress();
83  
84  
85      /***
86       * <p>Set the email address of this user.</p>
87       *
88       * @param emailAddress The new email address
89       */
90      public void setEmailAddress(String emailAddress);
91  
92  
93      /***
94       * <p>Return the full name of this user.</p>
95       */
96      public String getFullName();
97  
98  
99      /***
100      * <p>Set the full name of this user.</p>
101      *
102      * @param fullName The new full name
103      */
104     public void setFullName(String fullName);
105 
106 
107     /***
108      * <p>Return the primary key for this user.</p>
109      */
110     public int getId();
111 
112 
113     /***
114      * <p>Set the primary key for this user.</p>
115      *
116      * @param id The new primary key
117      */
118     public void setId(int id);
119 
120 
121 
122     /***
123      * <p>Return the password of this user.</p>
124      */
125     public String getPassword();
126 
127 
128     /***
129      * <p>Set the password of this user.</p>
130      *
131      * @param password The new password
132      */
133     public void setPassword(String password);
134 
135 
136     /***
137      * <p>Return the "last updated" timestamp for this user.</p>
138      */
139     public Date getUpdated();
140 
141 
142     /***
143      * <p>Set the "last updated" timestamp for this user.</p>
144      *
145      * @param updated The new last updated timestamp
146      */
147     public void setUpdated(Date updated);
148 
149 
150     /***
151      * <p>Return the username of this user.</p>
152      */
153     public String getUsername();
154 
155 
156     /***
157      * <p>Set the username of this user.</p>
158      *
159      * @param username The new username
160      */
161     public void setUsername(String username);
162 
163 
164 }