/*
* Copyright (C) 2009 eXo Platform SAS.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.etk.core.membership;
import java.util.Date;
/**
* Created by The eXo Platform SAS Author : Mestrallet Benjamin
* benjmestrallet@users.sourceforge.net Date: Aug 21, 2003 Time: 3:22:54 PM This
* is the interface for a User data model. The OrganizationService implementor
* can use the different strategy to implement this class, he can use the native
* field for each get method or use a Map to hold the user data. Note that after
* each set method is called. The developer need to call
*
* @see UserHandler saveUser(..) to persist the change
*/
public interface User
{
/**
* This method should return the username of the user. The username should be
* unique and the user database should not have 2 user record with the same
* username
*
* @return
*/
public String getUserName();
/**
* This method is used to change the username
*
* @param s
* @deprecated The third party developer should not used this method TODO: I
* think we should not have this method. the username should be
* set only for the first time. So we can pass the username to the @see
* UserHandler createUserInstance() method.
*/
public void setUserName(String s);
/**
* @return This method return the password of the user account
*/
public String getPassword();
/**
* This method is used to change the user account password.
*
* @param s
*/
public void setPassword(String s);
/**
* @return This method return the first name of the user
*/
public String getFirstName();
/**
* @param s the new first name
*/
public void setFirstName(String s);
/**
* @return The last name of the user
*/
public String getLastName();
/**
* @param s The new last name of the user
*/
public void setLastName(String s);
/**
* @return return the full name of the user. The full name shoul have the
* format: first name, last name by default
*/
public String getFullName();
/**
* @param s The name that should show in the full name
*/
public void setFullName(String s);
/**
* @return The email address of the user
*/
public String getEmail();
/**
* @param s The new user email address
*/
public void setEmail(String s);
/**
* @return The date that the user register or create the account
*/
public Date getCreatedDate();
/**
* @param t
* @deprecated The third party should not used this method.
*/
public void setCreatedDate(Date t);
/**
* @return Return the last time that the user access the account
*/
public Date getLastLoginTime();
/**
* @param t
* @deprecated The third party developer should not aware of this method
*/
public void setLastLoginTime(Date t);
/**
* @return the id of organization the user belongs to or null if not
* applicable
*/
String getOrganizationId();
/**
* sets the prganizationId
*/
void setOrganizationId(String organizationId);
}