package com.tootsville.tootsbook.client.util;

/**
 * WRITEME: Document this type. twheys@gmail.com Jan 19, 2010
 * 
 * @author <a href="mailto:twheys@gmail.com@resinteractive.com">Tim
 *         Heys</a>
 */
public class Message {

	/**
	 * Suggested color for Failure messages
	 */
	public static final String FAIL_COLOR = "#cc0033";

	/**
	 * Suggested color for Success messages
	 */
	public static final String SUCCESS_COLOR = "#7CC143";

	/**
	 * Suggested color for Warning messages
	 */
	public static final String WARNING_COLOR = "#ffff99";
	
	/**
	 * <pre>
	 * twheys@gmail.com Jan 19, 2010
	 * </pre>
	 * 
	 * TO getReportMessage WRITEME...
	 * 
	 * @param userName WRITEME
	 * @return WRITEME
	 */
	public static String getReportMessage (final String userName) {
		return userName + " has been reported to a Moderator.";
	}

	/**
	 * WRITEME twheys@gmail.com
	 */
	private String message = null;

	/**
	 * WRITEME twheys@gmail.com
	 */
	private String messageColor = null;
	
	/**
	 * Set a message to be displayed on the next page load.
	 * 
	 * @param messageToBeDisplayed The message being displayed.
	 * @param color A hexadecimal or CSS format color.
	 */
	public Message (final String messageToBeDisplayed,
			final String color) {
		message = messageToBeDisplayed;
		messageColor = color;
	}
	
	/**
	 * <pre>
	 * twheys@gmail.com Jan 19, 2010
	 * </pre>
	 * 
	 * TO getMessage WRITEME...
	 * 
	 * @return WRITEME twheys@gmail.com
	 */
	public String getMessage () {
		return message;
	}
	
	/**
	 * <pre>
	 * twheys@gmail.com Jan 19, 2010
	 * </pre>
	 * 
	 * TO getMessageColor WRITEME...
	 * 
	 * @return WRITEME twheys@gmail.com
	 */
	public String getMessageColor () {
		return messageColor;
	}
	
	/**
	 * <pre>
	 * twheys@gmail.com Jan 19, 2010
	 * </pre>
	 * 
	 * TO hasMessage WRITEME...
	 * 
	 * @return WRITEME twheys@gmail.com
	 */
	public boolean hasMessage () {
		return null != message;
	}
}