com.softicar.platform.common.core.user.IBasicUser Maven / Gradle / Ivy

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

The SoftiCAR Platform is a lightweight, Java-based library to create interactive business web applications.

There is a newer version: 50.0.0

package com.softicar.platform.common.core.user;

import com.softicar.platform.common.core.entity.IEntity;
import com.softicar.platform.common.core.locale.ILocale;

/**
 * Represents a basic user of the system.
 * 
 * This interface defines the minimum contract for a user object.
 *
 * @author Oliver Richers
 */
public interface IBasicUser extends IEntity {

	/**
	 * Returns the unique ID of this user.
	 *
	 * @return the user ID (never null)
	 */
	@Override
	Integer getId();

	/**
	 * Returns the formal login name of this user account.
	 * 
	 * Every user must have a unique login name.
	 *
	 * @return the user login name (never null)
	 */
	String getLoginName();

	/**
	 * Returns the {@link ILocale} of this user.
	 *
	 * @return the user {@link ILocale} (never null)
	 */
	ILocale getLocale();

	/**
	 * Compares this user to the given user.
	 *
	 * @param other
	 *            the other user (may be null)
	 * @return true if this user and the given user are identical;
	 *         false otherwise
	 */
	default boolean is(IBasicUser other) {

		return BasicUsers.isSame(this, other);
	}
}