ierrorsink.java

esri的ArcGIS Server超级学习模板程序（for java）

package com.esri.solutions.jitk.web.error;

/**
 * Acts as a temporary container for errors being observed.  This interface
 * allows for errors to be received, counted, exported, and cleared.
 */
public interface IErrorSink extends IErrorObserver {

	/**
	 * Clears the errors within this sink.  After the error are cleared,
	 * the {@link #count()} method should return zero.
	 */
	public void clear();
	
	/**
	 * Returns a count of the number of errors within the sink.  The count
	 * should be greater than or equal to 0.
	 * 
	 * @return Error count in sink.
	 */
	public int count ();
	
	/**
	 * Exports the errors within the sink to the specified exporter.  All
	 * errors within the sink will be sent to the exporter.  This method
	 * will invoke the methods in the exporter in the following order:
	 * 
	 * <ul>
	 * 	<li>{@link IErrorSinkExporter#begin()}
	 *  <li>{@link IErrorSinkExporter#setErrors(java.util.List)}
	 *  <li>{@link IErrorSinkExporter#export()}
	 *  <li>{@link IErrorSinkExporter#end()}
	 * </li>
	 * 
	 * @param exporter Handles exporting of errors.  Cannot be
	 * 					<code>null</code>.
	 */
	public void export (IErrorSinkExporter exporter);
}