imapcomposition.java

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

package com.esri.solutions.jitk.personalization.data;

import java.util.Date;
import java.util.List;
import java.util.UUID;

import com.esri.solutions.jitk.personalization.PersonalizationException;
import com.esri.solutions.jitk.personalization.data.beans.v1.MapCompositionType;

/**
 * Represents a single Map Composition.  A Map Composition is a collection of Map Services (ArcGIS Server,
 * ArcIMS, WMS, WFS, and WCS) as well as their Draw Order, TOC arrangement, and spatial reference.  To edit
 * the Map Composition, the bean returned by {@link #getMapComposition()} can be modified.  After editing, the
 * Map Composition will need to be saved, to save, invoke the {@link #save()} method.
 */
public interface IMapComposition {

	/**
	 * Returns the unique identifier for this Map Composition.  IDs of Map Compositions
	 * are represented by Universal Unique Identifiers (UUID).
	 * 
	 * @return  Unique identifier of this Map Composition, <code>null</code> will never be
	 * 			returned.
	 */
	public UUID getId ();
	
	/**
	 * Returns the name of this Map Composition.  The name is the human-readable text of the
	 * Map Composition.  
	 * 
	 * @return Human-readable name of this Map Composition
	 */
	public String getName ();
	
	/**
	 * Returns the description of this Map Composition.
	 * 
	 * @return Description of this Map Composition.
	 */
	public String getDescription ();
	
	/**
	 * Returns the bean that contains the actual data of the Map Composition.  Users of this
	 * object will use the bean to modify the Map Composition data.  The bean is based on an
	 * XML schema that describes the Map Composition structure.
	 * 
	 * @return Map Composition data, <code>null</code> will never be returned.
	 * 
	 * @throws PersonalizationException	Thrown if there was a problem getting the Map Composition data.
	 */
	public MapCompositionType getMapComposition () throws PersonalizationException;
	
	/**
	 * Saves the Map Composition to the back-end data store.  It is up to the implementations of this interface
	 * to determine the back-end data store.  If an error occurs while saving the Map Composition a
	 * {@link PersonalizationException} will be thrown.
	 * 
	 * @throws PersonalizationException	Thrown if an error occurs while saving.
	 */
	public void save () throws PersonalizationException;
	
	/**
	 * Removes the Map Composition from the back-end data store.  It is up to the implementations
	 * of this interface to determine the back-end data store.  If an error occurs while removing
	 * the Map Composition then a {@link PersonalizationException} will be thrown.
	 * 
	 * @throws PersonalizationException  Thrown if an error occurs while removing.
	 */
	public void remove () throws PersonalizationException;

	/**
	 * Returns the User that created this Map Composition.  
	 * 
	 * @return  User that created this Map Composition.
	 */
	public IUserId getCreatorUser();

	/**
	 * Indicates if this Map Composition is new.  If this method returns <code>true</code> then this
	 * Map Composition is new meaning it has not been saved.  If this method returns <code>false</code>
	 * then this Map Composition has been saved previously.
	 * 
	 * @return Flag indicating if the Map Composition has been previously saved.
	 */
	public boolean isNew();
	
	/**
	 * Retrieves the list of Queries that are associated with this Map Composition.
	 * 
	 * @return List of {@link IQuery} objects.  If no queries are associated with this
	 * 			Map Composition, then an empty list should be returned.  <code>null</code>
	 * 			should never be returned.
	 * 
	 * @throws PersonalizationException	Thrown if there was a problem retrieving
	 * 									the Queries.
	 */
	public List<IQuery> getQueries () throws PersonalizationException;

	/**
	 * Creates a Query that will exist within this Map Composition.
	 * 
	 * @return Newly created Query for this Map Composition.  <code>null</code>
	 * 			will never be returned.
	 * 
	 * @throws PersonalizationException	Thrown if there was a problem creating
	 * 									the Query.
	 */
	public IQuery createQuery (IQuery.Type type) throws PersonalizationException;
	
	/**
	 * Retrieves the list of Bookmarks that are associated with this Map Composition.
	 * 
	 * @return List of {@link IBookmark} objects.  If no bookmarks are associated
	 * 			with this Map Composition, then an empty list should be
	 * 			returned.  <code>null</code> should never be returned.
	 * 
	 * @throws PersonalizationException	Thrown if there was a problem retrieving the
	 * 									Bookmarks.
	 */
	public List<IBookmark> getBookmarks() throws PersonalizationException;
	
	/**
	 * Creates a Bookmark that will exist within this Map Composition.
	 * 
	 * @return	Newly created Bookmark for this Map Composition.  <code>null</code>
	 * 			will never be returned.
	 * 
	 * @throws PersonalizationException Thrown if there was a problem creating the Bookmark.
	 */
	public IBookmark createBookmark () throws PersonalizationException;

	/**
	 * Returns the Date that the Map Composition was last modified.  This
	 * Date will be in the Time Zone that is configured within the back-end
	 * data store.
	 * 
	 * @return Date the Map Composition was last modified.
	 */
	public Date getLastModifiedDate ();
	
}