iopenmapcomposition.java

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

package com.esri.solutions.jitk.web.tasks.mapcomp;

import java.util.List;

import com.esri.solutions.jitk.personalization.PersonalizationException;
import com.esri.solutions.jitk.personalization.data.IMapComposition;

/**
 * Defines an interface for opening a Map Composition within the map viewer.
 * Custom implementations can then be developed to open a Map Composition.  
 * Instances of this object can be injected into the {@link OpenMapCompositionTask}.
 *  
 */
public interface IOpenMapComposition {

	/**
	 * Opens a Map Composition within a map viewer.  
	 * 
	 * @param mc	Reference to Map Composition to open, cannot be <code>null</code>.
	 * 
	 * @throws PersonalizationException	Thrown if there was some unhandled
	 * 									error regarding Personalization.
	 */
	public void open (IMapComposition mc) throws PersonalizationException;
	
	/**
	 * Returns a list of messages that were generated by performing the open
	 * operation.  If no messages were generated, then this method should
	 * return an empty list.
	 * 
	 * @return List of messages.  <code>null</code> should not be returned.
	 */
	public List<String> getMessages ();
	
	/**
	 * Clears the list of messages that were generated by performing the
	 * open operation.
	 */
	public void clearMessages ();
}