001    /**
002     * Copyright 2005-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.krad.service;
017    
018    import org.kuali.rice.krad.bo.BusinessObject;
019    import org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata;
020    
021    import java.util.Collection;
022    
023    /**
024     * This service detects whether there are any records that block the inactivation of a particular record
025     *
026     * @author Kuali Rice Team (rice.collab@kuali.org)
027     */
028    public interface InactivationBlockingDetectionService {
029        /**
030         * Determines whether there is ANY record in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo
031         *
032         * @param blockedBo a BO that is potentially inactivation blocked
033         * @param inactivationBlockingMetadata
034         * @return true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata
035         */
036        public boolean hasABlockingRecord(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata);
037    
038        /**
039         * Lists all records in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo
040         *
041         * @param blockedBo a BO that is potentially inactivation blocked
042         * @param inactivationBlockingMetadata
043         * @return true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata
044         */
045        public Collection<BusinessObject> listAllBlockerRecords(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata);
046    }