imaptemplate.java

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

package com.esri.solutions.jitk.common.templates.map;

import java.awt.image.RenderedImage;

/**
 * Defines the operations that can be performed on a Map
 * Template.  A Map Template is set of Map resources that
 * comprise a viewable Map.  A Map Template is typically used
 * when a New Map Composition is created.  A User will be
 * able to choose a pre-configured template to use in order
 * to start a new Map Composition.
 */
public interface IMapTemplate extends IWebContextOpenable {

	/**
	 * Unique Identifier of this Map Template.  The ID must
	 * be unique within the Map Template Repository.
	 * 
	 * @return Unique Identifier
	 */
	public String getId ();
	
	/**
	 * Returns the name of the Map Template.  The Name is required
	 * and should not be <code>null</code>.  This method should
	 * not return <code>null</code>.
	 * 
	 * @return Map Template Name, should not be <code>null</code>.
	 */
	public String getName ();
	
	/**
	 * Returns the description of the Map Template.  The Description
	 * is not required.  This method will return <code>null</code>
	 * if the description is not provided.
	 * 
	 * @return Map Template Description
	 */
	public String getDescription ();
	
	/**
	 * Returns the {@link RenderedImage} object that represents the
	 * Preview Image of the Map Template.  The Preview Image
	 * is a thumbnail of the Map Template.  A Preview is required, so this
	 * method should not return <code>null</code>.
	 * 
	 * @return Preview of Map Template, <code>null</code> should not be
	 * 			returned.
	 */
	public RenderedImage getPreview();
	
	/**
	 * Returns the reference back to the Map Template Repository that
	 * stores this Map Template.  If this Map Template exists independently
	 * of a Map Template Repository, then <code>null</code> is returned.
	 * 
	 * @return Reference to Map Template Repository, or <code>null</code> if
	 * this Map Template exists independently of a Map Template Repository.
	 */
	public IMapTemplateRepository getRepository ();
	
	/**
	 * Sets the reference to the Map Template Repository that stores this
	 * Map Template.  This is optional as a Map Template can exist independent
	 * of a Map Template Repository.
	 * 
	 * @param repo	Reference to Map Template Repository.
	 */
	public void setRepository (IMapTemplateRepository repo);
	
}