View Javadoc
1   /**
2    * Copyright 2005-2015 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.krad.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  public class RouteToCompletionUtil {
27  
28      /**
29       * Checks if there is atleast one Ad-Hoc Completion request for the document and based on that returns a boolean
30       * 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(
36                  document.getAdHocRoutePersons());
37  
38          return foundAtleastOneCompleteReq;
39      }
40  
41      /**
42       * Loops and checks if the required value is present in the loop used for checking if there is atleast one adhoc
43       * completion
44       * request present for a person or work group
45       */
46      private static boolean loopAndCheckValue(List adhoc) {
47          if (adhoc == null) {
48              return false;
49          }
50  
51          ListIterator<AdHocRouteRecipient> groupIter = adhoc.listIterator();
52          String valueToCheck = null;
53          AdHocRouteRecipient recipient = null;
54  
55          boolean foundAtleastOneCompleteReq = false;
56          while (groupIter.hasNext()) {
57              recipient = groupIter.next();
58              valueToCheck = recipient.getActionRequested();
59              if (StringUtils.isNotEmpty(valueToCheck)) {
60                  if (KewApiConstants.ACTION_REQUEST_COMPLETE_REQ.equals(valueToCheck)) {
61                      foundAtleastOneCompleteReq = true;
62                      break;
63                  }
64              }
65          }
66  
67          return foundAtleastOneCompleteReq;
68      }
69  }