ExplanationResponse.java

package ecologylab.oodss.messages;

import ecologylab.collections.Scope;
import ecologylab.serialization.annotations.simpl_inherit;
import ecologylab.serialization.annotations.simpl_scalar;

/**
 * Base class for all ResponseMessages that indicate errors.
 * 
 * @author andruid, Zachary O. Toups (zach@ecologylab.net)
 */
@simpl_inherit public class ExplanationResponse<S extends Scope> extends
		ResponseMessage<S>
{
	@simpl_scalar protected String	explanation;

	public ExplanationResponse()
	{
		super();
	}

	public ExplanationResponse(String explanation)
	{
		this();
		this.explanation = explanation;
	}

	@Override public boolean isOK()
	{
		return true;
	}

	/**
	 * @return Returns the explanation.
	 */
	public String getExplanation()
	{
		return explanation;
	}

	/**
	 * @param explanation
	 *           the explanation to set
	 */
	public void setExplanation(String explanation)
	{
		this.explanation = explanation;
	}

}