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.krad.service;
17
18 import org.kuali.rice.krad.bo.BusinessObject;
19 import org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata;
20
21 import java.util.Collection;
22
23 /**
24 * This service detects whether there are any records that block the inactivation of a particular record
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 */
28 public interface InactivationBlockingDetectionService {
29 /**
30 * Determines whether there is ANY record in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo
31 *
32 * @param blockedBo a BO that is potentially inactivation blocked
33 * @param inactivationBlockingMetadata
34 * @return true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata
35 */
36 public boolean hasABlockingRecord(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata);
37
38 /**
39 * Lists all records in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo
40 *
41 * @param blockedBo a BO that is potentially inactivation blocked
42 * @param inactivationBlockingMetadata
43 * @return true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata
44 */
45 public Collection<BusinessObject> listAllBlockerRecords(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata);
46 }