001: /******************************************************************************
002: * JBoss, a division of Red Hat *
003: * Copyright 2006, Red Hat Middleware, LLC, and individual *
004: * contributors as indicated by the @authors tag. See the *
005: * copyright.txt in the distribution for a full listing of *
006: * individual contributors. *
007: * *
008: * This is free software; you can redistribute it and/or modify it *
009: * under the terms of the GNU Lesser General Public License as *
010: * published by the Free Software Foundation; either version 2.1 of *
011: * the License, or (at your option) any later version. *
012: * *
013: * This software is distributed in the hope that it will be useful, *
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
016: * Lesser General Public License for more details. *
017: * *
018: * You should have received a copy of the GNU Lesser General Public *
019: * License along with this software; if not, write to the Free *
020: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
021: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
022: ******************************************************************************/package org.jboss.portal.migration.model20.model;
023:
024: import java.util.Date;
025: import java.util.Set;
026:
027: /**
028: * A user.
029: *
030: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
031: * @author <a href="mailto:theute@jboss.org">Thomas Heute</a>
032: * @version $Revision: 8784 $
033: */
034: public interface User20 {
035: /**
036: * The user identifier.
037: *
038: * @return the user ID
039: */
040: Integer getID();
041:
042: /**
043: * The user name.
044: *
045: * @return the user name
046: */
047: String getUserName();
048:
049: /**
050: * The given name.
051: *
052: * @return the given name (firstname)
053: */
054: String getGivenName();
055:
056: void setGivenName(String givenName);
057:
058: /**
059: * The family name.
060: *
061: * @return the family name
062: */
063: String getFamilyName();
064:
065: void setFamilyName(String familyName);
066:
067: /**
068: *
069: */
070: String getRealEmail();
071:
072: void setRealEmail(String realEmail);
073:
074: String getFakeEmail();
075:
076: void setFakeEmail(String fakeEmail);
077:
078: Date getRegistrationDate();
079:
080: void setRegistrationDate(Date registrationDate);
081:
082: boolean getViewRealEmail();
083:
084: void setViewRealEmail(boolean viewRealEmail);
085:
086: String getPassword();
087:
088: void setPassword(String password);
089:
090: boolean getEnabled();
091:
092: void setEnabled(boolean enable);
093:
094: /** Return the last time the user logged in or null if this date is not known. */
095: Date getLastVisitDate();
096:
097: /** Returns the roles related to this user. */
098: Set getRoles();
099:
100: /** Update the roles. */
101: void setRoles(Set roles);
102:
103: /** Return all the role names of the user. */
104: Set getRoleNames();
105:
106: /** Returns the user properties. */
107: PropertyMap getProperties();
108:
109: /** Returns the user preference store. */
110: PreferenceStore getPreferenceStore();
111:
112: /** Returns the signature of the user (for forums for example) */
113: String getSignature();
114: }
|