1 /**
2 * Copyright 2005-2013 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.kns.util;
17
18 import org.apache.commons.lang.StringUtils;
19 import org.kuali.rice.kew.api.KewApiConstants;
20 import org.kuali.rice.krad.bo.AdHocRouteRecipient;
21 import org.kuali.rice.krad.document.Document;
22
23 import java.util.List;
24 import java.util.ListIterator;
25
26 //Adhoc Document Complete functionality utility
27 public class RouteToCompletionUtil {
28
29 /***
30 * Checks if there is atleast one Ad-Hoc Completion request for the document and based on that returns a boolean value.
31 */
32 public static boolean checkIfAtleastOneAdHocCompleteRequestExist(Document document) {
33 boolean foundAtleastOneCompleteReq = false;
34 // iterating the adhoc recpients list to check if there is atleast on complete request for the document.
35 foundAtleastOneCompleteReq = loopAndCheckValue(document.getAdHocRouteWorkgroups()) || loopAndCheckValue(document.getAdHocRoutePersons());
36 return foundAtleastOneCompleteReq;
37 }
38
39 /***
40 * Loops and checks if the required value is present in the loop used for checking if there is atleast one adhoc completion
41 * request present for a person or work group
42 */
43 public static boolean loopAndCheckValue(List adhoc) {
44 if (adhoc == null) {
45 return false;
46 }
47 ListIterator<AdHocRouteRecipient> groupIter = adhoc.listIterator();
48 String valueToCheck = null;
49 AdHocRouteRecipient recipient = null;
50 boolean foundAtleastOneCompleteReq = false;
51 while (groupIter.hasNext()) {
52 recipient = groupIter.next();
53 valueToCheck = recipient.getActionRequested();
54 if (StringUtils.isNotEmpty(valueToCheck)) {
55 if (KewApiConstants.ACTION_REQUEST_COMPLETE_REQ.equals(valueToCheck)) {
56 foundAtleastOneCompleteReq = true;
57 break;
58 }
59 }
60 }
61 return foundAtleastOneCompleteReq;
62 }
63 }