imapcompositionservice.java

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

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

import java.util.List;

import com.esri.solutions.jitk.personalization.dao.Criteria;
import com.esri.solutions.jitk.personalization.dao.IMapCompositionDAO;
import com.esri.solutions.jitk.personalization.dao.PageInfo;
import com.esri.solutions.jitk.services.common.ServicesException;
import com.esri.solutions.jitk.services.personalization.data.MapCompositionData;

/**
 * Interface defining methods that are necessary for the implementation of a Web Service that
 * manages and queries map compositions.  The map compositions are stored in some form of a datastore, which is
 * accessed through a {@link IMapCompositionDAO}.
 * <p>
 * The {@link IMapCompositionDAO} is responsible for all aspects of creating, selecting, updating and deleting
 * map composition.  Thus, it is the DAO that builds the queries, whereas this object simply abstracts away that
 * DAO for the purposes of creating a web service.
 * </p>
 */
public interface IMapCompositionService {

	/**
	 * Retrieves the Data Access Object (DAO) that accesses the map composition datastore. 
	 * @return {@link IMapCompositionDAO} implementation 
	 */
	public IMapCompositionDAO getDAO();

	/**
	 * Inserts a single map composition into the datastore.
	 * @param data The {@link MapCompositionData} representation of the map composition to insert.
	 */
	public void insert(MapCompositionData mapcomp) throws ServicesException;

	/**
	 * Updates a map composition with the given {@link MapCompositionData#getId() id} with the specified information.
	 * @param data The {@link MapCompositionData} encapsulation of the new map composition information.
	 */
	public void update(MapCompositionData mapcomp) throws ServicesException;

	/**
	 * Removes a single map composition from the datastore.
	 * @param id {@link String} containing the ID of the map composition to remove.
	 */
	public void delete(String id) throws ServicesException;

	/**
	 * Retrieves a single map composition, specified by its ID, from the datastore.
	 * @param id {@link String} containing the ID of the map composition to retrieve.
	 * @return {@link MapCompositionData} representation of the requested map composition.
	 */
	public MapCompositionData selectOne(String id) throws ServicesException;

	/**
	 * Retrieves all map compositions whose properties match those specified by the {@code criteria} parameter.
	 * @param criteria {@link Criteria} encapsulation of the map composition query parameters
	 * @return A {@link List} of {@link MapCompositionData} objects that match the specified criteria.
	 */
	public List<MapCompositionData> selectAll(Criteria criteria)
			throws ServicesException;

	/**
	 * Selects a count of all map compositions whose properties match those specified by the {@code criteria} parameter.
	 * @param criteria {@link Criteria} encapsulation of the map composition query parameters
	 * @return {@code int} containing the count.
	 */
	public int selectAllCount(Criteria criteria) throws ServicesException;

	/**
	 * Retrieves a subset of the map compositions whose criteria match those specified by the {@code criteria} parameter.
	 * <p>
	 * This method is similar to {@link #selectAll(Criteria)}, except in that it utilizes the {@code pageInfo} parameter
	 * to determine a subset of results to display.  This method is useful, in particular, for displaying paged results
	 * and limiting the amount of data returned to the client.
	 * </p>
	 * {@code pageInfo} parameter to specify the subset 
	 * @param criteria {@link Criteria} encapsulation of the map composition query parameters
	 * @param pageInfo {@link PageInfo} encapsulating the information used to determine the page of results
	 * @return A {@link List} of {@link MapCompositionData} objects that match the specified criteria, and fall within the specified subset
	 *         of the actual results.
	 */
	public List<MapCompositionData> selectPage(Criteria criteria,
			PageInfo pageInfo) throws ServicesException;

}