Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
DocumentRefreshQueue |
|
| 1.0;1 |
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.document; | |
17 | ||
18 | import org.kuali.rice.core.api.exception.RiceIllegalArgumentException; | |
19 | import org.kuali.rice.kew.api.KewApiConstants; | |
20 | ||
21 | import javax.jws.WebMethod; | |
22 | import javax.jws.WebParam; | |
23 | import javax.jws.WebService; | |
24 | import javax.jws.soap.SOAPBinding; | |
25 | ||
26 | /** | |
27 | * Defines the contract for a message queue which "refreshes" a document at it's current node. The refresh process will | |
28 | * delete all pending action requests at the current node(s) on the document and then send the document back through at | |
29 | * it's current node(s) so requests can be regenerated. | |
30 | * | |
31 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
32 | */ | |
33 | @WebService(name = "documentRefreshQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0) | |
34 | @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED) | |
35 | public interface DocumentRefreshQueue { | |
36 | ||
37 | @WebMethod(operationName = "refreshDocument") | |
38 | void refreshDocument(@WebParam(name = "documentId") String documentId) throws RiceIllegalArgumentException; | |
39 | ||
40 | } |