imaptemplaterepository.java

来自「esri的ArcGIS Server超级学习模板程序（for java）」· Java 代码 · 共 60 行

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

import java.util.List;

/**
 * Maintains a collection of Map Templates.  This interface will
 * provide various accessors for accessing the Map Templates.
 */
public interface IMapTemplateRepository {

	/**
	 * Returns all the Map Templates within the repository.  If
	 * there are no Map Templates in the repository then an
	 * empty List will be returned.  <code>null</code> should
	 * never be returned.  Use caution in invoking this method as the
	 * number of Map Templates could be large.
	 * 
	 * @return List of Map Templates.  Empty List will be returned if
	 * 			there are no Map Templates in the repository.  <code>null</code>
	 * 			should never be returned.
	 */
	public List<IMapTemplate> getMapTemplates ();
	
	/**
	 * Returns the Map Template with the specified ID.  If there is
	 * no Map Template with the specified ID then <code>null</code>
	 * will be returned.
	 * 
	 * @param id ID of the Map Template, cannot be <code>null</code>.
	 * @return Map Template with matching ID, or <code>null</code> if
	 * 			no Map Template found.
	 */
	public IMapTemplate getMapTemplate (String id);
	
	/**
	 * Returns the list of Map Templates within the specified page 
	 * boundaries.  This method will return a fixed amount of Map Templates.
	 * This method should be used for paging between large numbers of
	 * Map Templates.  If there are no Map Templates in the repository
	 * or if there are no Map Templates within the page boundaries, then
	 * an Empty List is returned.  <code>null</code> should never be 
	 * returned.
	 * 
	 * @param page  Contains page boundary information (page number, page size),
	 * 				cannot be <code>null</code>.
	 * @return List of Map Templates that fall into the page boundary.
	 * 			<code>null</code> should never be returned.
	 */
	public List<IMapTemplate> getMapTemplates (PageInfo page);
	
	/**
	 * Returns the count of the number of Map Templates in the 
	 * repository.  The returned value should be greater than or equal
	 * to 0.
	 * 
	 * @return Number of Map Templates in the repository.
	 */
	public int getMapTemplateCount ();
}