ierror.java

A Java web application, based on Struts and Hibernate, that serves as an online running log. Users m

/* @LICENSE_COPYRIGHT@ */
package net.sf.irunninglog.util;

import java.io.Serializable;

/**
 * Interface definition for errors within the application.  This interface
 * must be implemented by any error objects that will be used in conjuntion
 * with <code>DTO</code>s.  The various error-related <code>DTO</code>
 * operations alll require instances of the <code>IError</code> interface.
 *
 * @author <a href="mailto:[e-mail]">Allan Lewis</a>
 * @version $Revision: 1.1.1.1 $ $Date: 2005/06/23 01:49:03 $
 * @since iRunningLog 1.0
 * @see DTO
 */
public interface IError extends Serializable {

    /**
     * Get the error's key.  This method will return the key that uniquely
     * identifies the error.
     *
     * @return The error's key
     */
    String getKey();

    /**
     * Get the error's list of inserts.  This method will return a copy of the
     * list to prevent external classes from modifying the list's values.
     *
     * @return The error's list of inserts
     */
    String [] getInserts();

}