isavemapcomposition.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 saving and updating a Map Composition from the map viewer.
 * Custom implementations can be created to save and update Map Compositions.
 * Implementations of this interface are responsible for converting information
 * within the Java ADF into the Map Composition.
 *
 */
public interface ISaveMapComposition {

	/**
	 * Converts information within the Java ADF into a Map Composition.  The
	 * Map Composition is returned. The {@link ISaveMapCompositionFormData}
	 * provides basic information (ID, Name, Description) for saving the
	 * Map Composition.  This method will save the Map Composition in the Personalization
	 * for the user.
	 * 
	 * @param formData	Provides basic data (ID, Name, Description) for saving
	 * 					the Map Composition.
	 * @return {@link IMapComposition} that was saved.
	 * 
	 * @throws PersonalizationException
	 */
	public IMapComposition save (ISaveMapCompositionFormData formData) throws PersonalizationException;
	
	/**
	 * Converts information within the Java ADF into a Map Composition.  This
	 * method will NOT save the Map Composition in the back-end data store.  It
	 * is meant to only update the Map Composition with information from the
	 * Java ADF and map viewer.
	 * 
	 * @param mc	Reference to Map Composition to update, cannot be <code>null</code>.
	 * 
	 * @throws PersonalizationException	Thrown if there was a personalization error.
	 */
	public void update (IMapComposition mc) throws PersonalizationException;
	
	/**
	 * Returns the list of messages that were generated by performing the save
	 * or update operation.  If no messages were generated then an empty list
	 * will be returned.
	 * 
	 * @return List of messages.  <code>null</code> will never be returned.
	 */
	public List<String> getMessages ();
	
	/**
	 * Clears the list of messages that were generated by the save or update operation.
	 * 
	 */
	public void clearMessages ();
}