Account.java

package info.interactivesystems.gamificationengine.entities;

import java.io.Serializable;

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.validation.constraints.NotNull;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

/**
 * An Account has to be created for at least one manager or developer. It
 * is identified by a unique email address. The password ensures the
 * identity. Optionally an account may have information about the user in form
 * of her/his first name and last name.
 * It is possible to change the password, the first name or last name 
 * at a later point of time. In addition to creating an account another 
 * possible request is to get the created account but only with the 
 * correct credentials.
 */
@Entity
@JsonIgnoreProperties({"password"})
public class Account implements Serializable {

	private static final long serialVersionUID = -683022088070098L;

	@Id
	@NotNull
	private String email;

	@NotNull
	private String password;

	private String firstName;

	private String lastName;

	public Account(String email) {
		super();
		this.email = email;
	}

	public Account() {
		super();
	}

	/**
	 * Gets the email address of an Account. 
	 * This email address is unique.
	 * 
	 * @return String representing the email address.
	 */
	public String getEmail() {
		return email;
	}

	/**
	 * Set the email address for an Account.
	 * This email address has to be unique.
	 * 
	 * @param email
	 *            the email address for the Account
	 */
	public void setEmail(@NotNull String email) {
		this.email = email;
	}

	/**
	 * Gets the password for the Account.
	 * 
	 * @return String representing the password.
	 */
	public String getPassword() {
		return password;
	}

	/**
	 * Sets the password for the Account.
	 * 
	 * @param password
	 *            the password for the Account
	 */
	public void setPassword(@NotNull String password) {
		this.password = password;
	}

	/**
	 * Gets the first name of the Account user.
	 * 
	 * @return String representing the first Name.
	 */
	public String getFirstName() {
		return firstName;
	}

	/**
	 * Sets the first name of the Account user.
	 * 
	 * @param firstName
	 *            the first name of the Account user
	 */
	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}

	/**
	 * Gets the last name of the Account user.
	 * 
	 * @return String representing the last name.
	 */
	public String getLastName() {
		return lastName;
	}

	/**
	 * Sets the last name of the Account user.
	 * 
	 * @param lastName
	 *            the last name of the Account user
	 */
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	
	/**
	 * Checks if the passed password is equal to the hashed password.
	 * 
	 * @param checkPassword
	 * 			The password that should be checked.
	 * @return Returns a boolean value if the passed password is equal to the hashed password (true) else false.
	 */
	public boolean checkPassword(String checkPassword) {
		return this.password.equals(checkPassword);
	}
}