package org.springside.examples.miniservice.ws.user;

import javax.jws.WebParam;
import javax.jws.WebService;

import org.springside.examples.miniservice.ws.Constants;
import org.springside.examples.miniservice.ws.WSResult;
import org.springside.examples.miniservice.ws.user.dto.CreateUserResult;
import org.springside.examples.miniservice.ws.user.dto.GetAllUserResult;
import org.springside.examples.miniservice.ws.user.dto.GetUserResult;
import org.springside.examples.miniservice.ws.user.dto.UserDTO;

/**
 * JAX-WS2.0的WebService接口定義類.
 * 
 * 使用@WebService將接口中的所有方法輸出為Web Service. 
 * 使用JAX-WS2.0 annotation設置方法、參數和返回值在WSDL中的定義.
 * 使用WebServiceResult及其子類類包裹返回結果.
 * 使用DTO傳輸對象隔絕系統內部領域對象修改對外系統的影響.
 * 
 * @author sky
 * @author calvin
 */
@WebService(name = "UserService", targetNamespace = Constants.NS)
public interface UserWebService {
	/**
	 * 顯示所有用戶.
	 */
	GetAllUserResult getAllUser();

	/**
	 * 根據用戶ID獲得用戶.
	 */
	GetUserResult getUser(@WebParam(name = "userId") Long userId);

	/**
	 * 新建用戶.
	 */
	CreateUserResult createUser(@WebParam(name = "user") UserDTO user);

	/**
	 * 驗證用戶名密碼.
	 */
	WSResult authUser(@WebParam(name = "loginName") String loginName, @WebParam(name = "password") String password);
}