001    /**
002     * Copyright 2005-2012 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kew.api.note;
017    
018    import java.util.List;
019    
020    import javax.jws.WebMethod;
021    import javax.jws.WebParam;
022    import javax.jws.WebResult;
023    import javax.jws.WebService;
024    import javax.jws.soap.SOAPBinding;
025    import javax.xml.bind.annotation.XmlElement;
026    import javax.xml.bind.annotation.XmlElementWrapper;
027    
028    import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
029    import org.kuali.rice.kew.api.KewApiConstants;
030    
031    @WebService(name = "noteService", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
032    @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
033    public interface NoteService {
034    
035        @WebMethod(operationName = "getNotes")
036        @WebResult(name = "notes")
037        @XmlElementWrapper(name = "notes", required = true)
038        @XmlElement(name = "note", required = false)
039        List<Note> getNotes(@WebParam(name = "documentId") String documentId) throws RiceIllegalArgumentException;
040    
041        @WebMethod(operationName = "getNote")
042        @WebResult(name = "note")
043        @XmlElement(name = "note", required = false)
044        Note getNote(@WebParam(name = "noteId") String noteId) throws RiceIllegalArgumentException;
045    
046        @WebMethod(operationName = "createNote")
047        @WebResult(name = "note")
048        @XmlElement(name = "note", required = true)
049        Note createNote(@WebParam(name = "note") Note note) throws RiceIllegalArgumentException;
050    
051        @WebMethod(operationName = "update")
052        @WebResult(name = "note")
053        @XmlElement(name = "note", required = true)
054        Note updateNote(@WebParam(name = "note") Note note) throws RiceIllegalArgumentException;
055    
056        @WebMethod(operationName = "deleteNote")
057        @WebResult(name = "note")
058        @XmlElement(name = "note", required = true)
059        Note deleteNote(@WebParam(name = "noteId") String noteId) throws RiceIllegalArgumentException;
060    
061    }