001/**
002 * Copyright 2005-2016 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.datadictionary;
017
018/**
019 * This interface provides read-only metadata about inactivation blocking.  This metadata object is associated with a business object.
020 * The source of this information often comes from the data dictionary file.
021 *  
022 * @author Kuali Rice Team (rice.collab@kuali.org)
023 *
024 */
025public interface InactivationBlockingMetadata {
026
027    /**
028     * The property name of the reference that is blocked
029     */
030    public String getBlockedReferencePropertyName();
031
032    /**
033     * The type of the object that is blocked
034     * 
035     * @return
036     */
037    public Class getBlockedBusinessObjectClass();
038
039    /**
040     * The bean name of the service that is responsible for determining whether there are any records that block inactivation
041     * 
042     */
043    public String getInactivationBlockingDetectionServiceBeanName();
044
045    /**
046     * The type of the object that is blocking another record
047     */
048    public Class getBlockingReferenceBusinessObjectClass();
049    
050    /**
051     * Returns the human-meaningful name of the relationship
052     * 
053     * @return
054     */
055    public String getRelationshipLabel();
056}