User.java :  » Content-Management-System » webman » de » webman » sync » Java Open Source

package de.webman.sync;

import java.util.List;

/**
 * Represents a user as returned from an access control adaptor
 *
 * @author <a href="mailto:gregor@webman.de">Gregor Klinke</a>
 * @version $Revision: 1.2 $
 **/
public interface User 
{
    /* $Id: User.java,v 1.2 2002/04/12 14:56:01 gregor Exp $ */

    /**
     * returns a list of all webman groups the user is listed in the
     * external acl system for.  The list contains java.lang.String
     * elements. 
     * @return s.a.
     */
    List getGroups();

    /**
     * returns the id of the user in the acl system specific format.
     * @return s.a.
     */
    String getID();
    
    /**
     * returns the id of the user in the webman specific format (the
     * "login" name) 
     * @return s.a.
     */
    String getWebmanName();

    /**
     * returns a display name of the user (which is maybe his/her real name)
     * @return s.a.
     **/
    String getDisplayName();

    /**
     * returns <code>true</code> if the user entry has been changed/added
     * in the external acl system 
     * @return s.a.
     */
    boolean isDirty();
}