org.bonitasoft.engine.identity.User Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bonita-common Show documentation

Bonita Common is the useful layer common to bonita-client and bonita-server

There is a newer version: 10.2.0

/**
 * Copyright (C) 2019 Bonitasoft S.A.
 * Bonitasoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library 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
 * version 2.1 of the License.
 * This library 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
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.identity;

import java.util.Date;

import org.bonitasoft.engine.bpm.BonitaObject;

/**
 * Represents a user inside the organization.
 *
 * @author Yanyan Liu
 * @author Matthieu Chaffotte
 * @author Celine Souchet
 * @see org.bonitasoft.engine.api.UserAPI
 * @since 6.0.0
 */
public interface User extends BonitaObject {

    /**
     * @return The identifier of the user
     */
    long getId();

    /**
     * deprecated since 6.3.1
     *
     * @return The user's password
     */
    @Deprecated
    String getPassword();

    /**
     * @return The user's firstname
     */
    String getFirstName();

    /**
     * @return The user's lastname
     */
    String getLastName();

    /**
     * @return The user's username
     */
    String getUserName();

    /**
     * @return The user's icon name
     */
    @Deprecated
    String getIconName();

    /**
     * @return The user's icon path
     */
    @Deprecated
    String getIconPath();

    /**
     * @return The user's title
     */
    String getTitle();

    /**
     * @return The user's job title
     */
    String getJobTitle();

    /**
     * @return The user's creation date
     */
    Date getCreationDate();

    /**
     * @return The user's id that created the user
     */
    long getCreatedBy();

    /**
     * @return The user's last update date
     */
    Date getLastUpdate();

    /**
     * @return The user's last connection date
     */
    Date getLastConnection();

    /**
     * @return The user's manager id
     */
    long getManagerUserId();

    /**
     * @return true if the user is enabled
     */
    boolean isEnabled();

    /**
     * @deprecated As of 6.0 Use {@link #getManagerUserId()} instead
     */
    //FIXME Remove ASAP
    @Deprecated
    String getManagerUserName();

    /**
     * @return the id of the icon used as avatar
     */
    Long getIconId();

}