1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.kuali.rice.kew.actions;
18
19 import org.apache.log4j.MDC;
20 import org.kuali.rice.kew.actionrequest.ActionRequestValue;
21 import org.kuali.rice.kew.actiontaken.ActionTakenValue;
22 import org.kuali.rice.kew.doctype.DocumentTypePolicy;
23 import org.kuali.rice.kew.exception.InvalidActionTakenException;
24 import org.kuali.rice.kew.exception.ResourceUnavailableException;
25 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
26 import org.kuali.rice.kew.service.KEWServiceLocator;
27 import org.kuali.rice.kew.util.KEWConstants;
28 import org.kuali.rice.kim.api.identity.principal.PrincipalContract;
29
30
31 import java.util.Iterator;
32 import java.util.List;
33
34
35
36
37
38
39
40
41
42
43
44
45 public class CompleteAction extends ActionTakenEvent {
46 private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(CompleteAction.class);
47
48
49
50
51
52
53
54 public CompleteAction(DocumentRouteHeaderValue rh, PrincipalContract principal) {
55 super(KEWConstants.ACTION_TAKEN_COMPLETED_CD, rh, principal);
56 }
57
58
59
60
61
62
63
64
65
66 public CompleteAction(DocumentRouteHeaderValue rh, PrincipalContract principal, String annotation) {
67 super(KEWConstants.ACTION_TAKEN_COMPLETED_CD, rh, principal, annotation);
68 }
69
70
71
72
73 @Override
74 public String validateActionRules() {
75 return validateActionRules(getActionRequestService().findAllPendingRequests(routeHeader.getDocumentId()));
76 }
77
78 public String validateActionRules(List<ActionRequestValue> actionRequests) {
79 if (!getRouteHeader().isValidActionToTake(getActionPerformedCode())) {
80 return "Document is not in a state to be completed";
81 }
82 List<ActionRequestValue> filteredActionRequests = filterActionRequestsByCode(actionRequests, KEWConstants.ACTION_REQUEST_COMPLETE_REQ);
83 if (!isActionCompatibleRequest(filteredActionRequests)) {
84 return "No request for the user is compatible " + "with the COMPLETE action";
85 }
86 return "";
87 }
88
89
90
91
92 @Override
93 public boolean isActionCompatibleRequest(List requests) {
94
95 if (requests.isEmpty()) {
96 return true;
97 }
98
99
100 if (routeHeader.isStateInitiated() || routeHeader.isStateSaved()) {
101 return true;
102 }
103
104 boolean actionCompatible = false;
105 Iterator ars = requests.iterator();
106 ActionRequestValue actionRequest = null;
107
108 while (ars.hasNext()) {
109 actionRequest = (ActionRequestValue) ars.next();
110 String request = actionRequest.getActionRequested();
111
112
113 if ( (KEWConstants.ACTION_REQUEST_FYI_REQ.equals(request)) ||
114 (KEWConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ.equals(request)) ||
115 (KEWConstants.ACTION_REQUEST_APPROVE_REQ.equals(request)) ||
116 (KEWConstants.ACTION_REQUEST_COMPLETE_REQ.equals(request)) ) {
117 actionCompatible = true;
118 break;
119 }
120 }
121 return actionCompatible;
122 }
123
124
125
126
127
128
129
130 public void recordAction() throws org.kuali.rice.kew.exception.InvalidActionTakenException {
131 MDC.put("docId", getRouteHeader().getDocumentId());
132 updateSearchableAttributesIfPossible();
133 LOG.debug("Completing document : " + annotation);
134
135 List actionRequests = getActionRequestService().findAllValidRequests(getPrincipal().getPrincipalId(), getDocumentId(), KEWConstants.ACTION_REQUEST_COMPLETE_REQ);
136 if (actionRequests == null || actionRequests.isEmpty()) {
137 DocumentTypePolicy allowUnrequested = getRouteHeader().getDocumentType().getAllowUnrequestedActionPolicy();
138 if (allowUnrequested != null) {
139 if (!allowUnrequested.getPolicyValue()) {
140 throw new InvalidActionTakenException("No request for the user is compatible " + "with the COMPLETE action. " + "Doctype policy ALLOW_UNREQUESTED_ACTION is set to false and someone else likely just took action on the document.");
141 }
142 }
143 }
144 LOG.debug("Checking to see if the action is legal");
145 String errorMessage = validateActionRules(actionRequests);
146 if (!org.apache.commons.lang.StringUtils.isEmpty(errorMessage)) {
147 throw new InvalidActionTakenException(errorMessage);
148 }
149
150 LOG.debug("Record the complete action");
151 ActionTakenValue actionTaken = saveActionTaken(findDelegatorForActionRequests(actionRequests));
152
153 LOG.debug("Deactivate all pending action requests");
154 getActionRequestService().deactivateRequests(actionTaken, actionRequests);
155 notifyActionTaken(actionTaken);
156
157 boolean isException = getRouteHeader().isInException();
158 boolean isSaved = getRouteHeader().isStateSaved();
159 if (isException || isSaved) {
160 String oldStatus = getRouteHeader().getDocRouteStatus();
161 LOG.debug("Moving document back to Enroute from "+KEWConstants.DOCUMENT_STATUSES.get(oldStatus));
162 getRouteHeader().markDocumentEnroute();
163 String newStatus = getRouteHeader().getDocRouteStatus();
164 notifyStatusChange(newStatus, oldStatus);
165 KEWServiceLocator.getRouteHeaderService().saveRouteHeader(getRouteHeader());
166 }
167 }
168
169 }