iuserservice.java

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

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

import com.esri.solutions.jitk.personalization.dao.IUserDAO;
import com.esri.solutions.jitk.services.common.ServicesException;
import com.esri.solutions.jitk.services.personalization.data.UserData;

/**
 * Interface defining methods that are necessary for the implementation of a Web
 * Service that manages and queries users. The users are stored in some form of
 * a datastore, which is accessed through a {@link IUserDAO}.
 * <p>
 * The {@link IUserDAO} is responsible for all aspects of creating, selecting,
 * updating and deleting user. 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 IUserService {

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

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

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

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

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