001/**
002 * Copyright 2005-2018 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 */
016package org.kuali.rice.krad.service;
017
018import org.kuali.rice.krad.bo.BusinessObject;
019import org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata;
020
021import 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 */
028public interface InactivationBlockingDetectionService {
029
030    /**
031     * Determines whether there is ANY record in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo
032     *
033     * @param blockedBo a BO that is potentially inactivation blocked
034     * @param inactivationBlockingMetadata
035     * @return true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata
036     *
037     * @deprecated use {@link #detectBlockingRecord(Object, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata)}
038     */
039    @Deprecated
040    boolean hasABlockingRecord(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata);
041
042    /**
043     * Detects if there is ANY record in the relationship defined in the given metadata that prevents inactivation of
044     * the given data object.
045     *
046     * @param dataObject data object to check for inactivation blocking
047     * @param inactivationBlockingMetadata metadata to use for the inactivation blocking check
048     * @return true if there is any record which would block inactivation of the given data object, false otherwise
049     *
050     * @throws IllegalArgumentException if either dataObject or inactivationBlockingMetadata is null
051     */
052    boolean detectBlockingRecord(Object dataObject, InactivationBlockingMetadata inactivationBlockingMetadata);
053
054    /**
055     * Lists all records in the relationship defined by the inactivationBlockingMetadata that prevents inactivation of blockedBo
056     *
057     * @param blockedBo a BO that is potentially inactivation blocked
058     * @param inactivationBlockingMetadata
059     * @return true iff there was a record that blocks the blockedBo using the metadata in inactivationBlockingMetadata
060     *
061     * @deprecated use {@link #detectAllBlockingRecords(Object, org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata)}
062     */
063    @Deprecated
064    Collection<BusinessObject> listAllBlockerRecords(BusinessObject blockedBo, InactivationBlockingMetadata inactivationBlockingMetadata);
065
066    /**
067     * Detects all records in the relationship defined in the given metadata that prevents inactivation of the given
068     * data object.
069     *
070     * @param dataObject data object to check for inactivation blocking
071     * @param inactivationBlockingMetadata metadata to use for the inactivation blocking check
072     * @return an immutable list of records which are blocking inactivation of the given data object
073     *
074     * @throws IllegalArgumentException if either dataObject or inactivationBlockingMetadata is null
075     */
076    Collection<?> detectAllBlockingRecords(Object dataObject, InactivationBlockingMetadata inactivationBlockingMetadata);
077}