View Javadoc

1   /**
2    * Copyright 2005-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.kew.api.note;
17  
18  import java.util.List;
19  
20  import javax.jws.WebMethod;
21  import javax.jws.WebParam;
22  import javax.jws.WebResult;
23  import javax.jws.WebService;
24  import javax.jws.soap.SOAPBinding;
25  import javax.xml.bind.annotation.XmlElement;
26  import javax.xml.bind.annotation.XmlElementWrapper;
27  
28  import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
29  import org.kuali.rice.kew.api.KewApiConstants;
30  
31  @WebService(name = "noteService", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
32  @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
33  public interface NoteService {
34  
35      @WebMethod(operationName = "getNotes")
36      @WebResult(name = "notes")
37      @XmlElementWrapper(name = "notes", required = true)
38      @XmlElement(name = "note", required = false)
39      List<Note> getNotes(@WebParam(name = "documentId") String documentId) throws RiceIllegalArgumentException;
40  
41      @WebMethod(operationName = "getNote")
42      @WebResult(name = "note")
43      @XmlElement(name = "note", required = false)
44      Note getNote(@WebParam(name = "noteId") String noteId) throws RiceIllegalArgumentException;
45  
46      @WebMethod(operationName = "createNote")
47      @WebResult(name = "note")
48      @XmlElement(name = "note", required = true)
49      Note createNote(@WebParam(name = "note") Note note) throws RiceIllegalArgumentException;
50  
51      @WebMethod(operationName = "update")
52      @WebResult(name = "note")
53      @XmlElement(name = "note", required = true)
54      Note updateNote(@WebParam(name = "note") Note note) throws RiceIllegalArgumentException;
55  
56      @WebMethod(operationName = "deleteNote")
57      @WebResult(name = "note")
58      @XmlElement(name = "note", required = true)
59      Note deleteNote(@WebParam(name = "noteId") String noteId) throws RiceIllegalArgumentException;
60  
61  }