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.service;
17  
18  import org.kuali.rice.krad.bo.BusinessObject;
19  import org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata;
20  
21  import java.util.List;
22  
23  /**
24   * A service that helps to print out records that block the inactivation of another BO
25   *
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   *
28   */
29  public interface InactivationBlockingDisplayService {
30  
31      /**
32  	 * Retrieves a List of Strings representing each record that blocks the inactivation of blockedBo
33  	 *
34  	 * @param blockedBo
35  	 * @param inactivationBlockingMetadata the blocking relationship
36  	 * @return list of blocking records
37       *
38       * @deprecated use {@link #displayAllBlockingRecords(Object, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata)} instead
39  	 */
40      @Deprecated
41  	List<String> listAllBlockerRecords(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata);
42  
43      /**
44       * Retrieves a List of Strings representing each record that blocks the inactivation of blockedDataObject
45       *
46       * @param blockedDataObject
47       * @param inactivationBlockingMetadata the blocking relationship
48       * @return list of all bocking records
49       */
50      List<String> displayAllBlockingRecords(Object blockedDataObject, InactivationBlockingMetadata inactivationBlockingMetadata);
51  
52  }