br.com.jhonsapp.finaluser.domain.PersonUser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of final-user Show documentation

A bunch of classes that help developers building login and authentication.

The newest version!

package br.com.jhonsapp.finaluser.domain;

/**
 * This interface represents a person user in a application.
 * 
 * @see RoleGroup
 * @see User
 * 
 * @author Jhonathan Camacho
 * @author Jhonys Camacho
 *
 */
public interface PersonUser extends User {

	/**
	 * Returns the user e-mail.
	 * 
	 * @return the user e-mail.
	 */
	public String getEmail();

	/**
	 * Sets the user e-mail.
	 * 
	 * @param email
	 *            the user e-mail. The e-mail shuold be valid, i.e., not null
	 *            and with domain (e.g., [email protected]).
	 */
	public void setEmail(String email);

	/**
	 * Returns the user password.
	 * 
	 * @return the user password
	 */
	public String getPassword();

	/**
	 * Sets the user password.
	 * 
	 * @param password
	 *            the user password.
	 */
	public void setPassword(String password);

	/**
	 * Returns the android token.
	 * 
	 * @return the android token
	 */
	public String getAndroidToken();

	/**
	 * Add the android token.
	 * 
	 * @param token
	 *            the android token
	 */
	public void setAndroidToken(String token);

	/**
	 * Returns the code that makes it possible to update the password.
	 * 
	 * @return the code that makes it possible to update the password.
	 */
	public String getResetPasswordCode();

	/**
	 * Returns true if there is no code that makes it possible to update the
	 * password and false otherwise.
	 * 
	 * @return true if there is no code that makes it possible to update the
	 *         password and false otherwise.
	 */
	public boolean isResetPasswordCodeEmpty();

	/**
	 * Clears the code used to reset the password.
	 */
	public void clearResetPasswordCode();

}