View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.common.messages.service;
17  
18  import javax.jws.WebMethod;
19  import javax.jws.WebParam;
20  import javax.jws.WebService;
21  import javax.jws.soap.SOAPBinding;
22  
23  import org.kuali.student.common.messages.dto.LocaleKeyList;
24  import org.kuali.student.common.messages.dto.Message;
25  import org.kuali.student.common.messages.dto.MessageGroupKeyList;
26  import org.kuali.student.common.messages.dto.MessageList;
27  
28  
29  @WebService(name = "MessageService", targetNamespace = "http://student.kuali.org/wsdl/messages")
30  @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
31  public interface MessageService {
32  
33  	 @WebMethod
34  	    public LocaleKeyList getLocales();
35  
36  	    @WebMethod
37  	    public MessageGroupKeyList getMessageGroups();
38  
39  	    @WebMethod
40  	    public Message getMessage(
41  	            @WebParam(name = "localeKey") String localeKey, 
42  	            @WebParam(name = "messageGroupKey") String messageGroupKey, 
43  	            @WebParam(name = "messageKey")   String messageKey);
44  	    
45  	    @WebMethod
46  	    public MessageList getMessages(
47  	            @WebParam(name = "localeKey") String localeKey, 
48  	            @WebParam(name = "messageGroupKey") String messageGroupKey);
49  	    
50  	    @WebMethod
51  	    public MessageList getMessagesByGroups(
52  	            @WebParam(name = "localeKey") String localeKey, 
53  	            @WebParam(name = "messageGroupKeyList") MessageGroupKeyList messageGroupKeyList);
54  	    
55  	    @WebMethod
56  	    public Message updateMessage(
57  	    		@WebParam(name = "localeKey") String localeKey, 
58  	            @WebParam(name = "messageGroupKey") String messageGroupKey, 
59  	            @WebParam(name = "messageKey")  String messageKey,
60  	            @WebParam(name = "messageInfo") Message messageInfo);
61  	    
62  	    @WebMethod
63  	    public Message addMessage(@WebParam(name = "messageInfo") Message messageInfo);
64  	    
65  }