001/**
002 * Copyright 2005-2014 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
018import org.kuali.rice.krad.bo.BusinessObject;
019
020/**
021 * This interface provides read-only metadata about inactivation blocking.  This metadata object is associated with a
022 * data object. The source of this information often comes from the data dictionary file.
023 *
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026public interface InactivationBlockingMetadata {
027
028    /**
029     * The property name of the reference on the blocked object which points to the blocking object.
030     *
031     * @return the name of the blocking reference
032     * @deprecated use {@link #getBlockedAttributeName()} instead
033     */
034    @Deprecated
035    String getBlockedReferencePropertyName();
036
037    /**
038     * The name of the attribute which is blocked by the blocking object.
039     *
040     * @return the name of the blocked attribute
041     */
042    String getBlockedAttributeName();
043
044    /**
045     * The type of the object that is blocked.
046     *
047     * @return the type of the business object that is blocked
048     *
049     * @deprecated use {@link #getBlockedDataObjectClass()} instead, there is no requirement that the blocked class
050     *             must implement the deprecated {@link BusinessObject} interface.
051     */
052    @Deprecated
053    Class<? extends BusinessObject> getBlockedBusinessObjectClass();
054
055    /**
056     * Returns the type of the data object that is blocked.
057     *
058     * @return the type of the data object that is blocked, should never be null
059     */
060    Class<?> getBlockedDataObjectClass();
061
062    /**
063     * The bean name of the service that is responsible for determining whether there are any records that block
064     * inactivation
065     */
066    String getInactivationBlockingDetectionServiceBeanName();
067
068    /**
069     * The type of the object that is blocking another record.
070     *
071     * @return the type of the object that is blocking
072     *
073     * @deprecated use {@link #getBlockingDataObjectClass()} instead, there is no requirement that the blocking class
074     *             must implement the deprecated {@link BusinessObject} interface.
075     */
076    @Deprecated
077    Class<? extends BusinessObject> getBlockingReferenceBusinessObjectClass();
078
079    /**
080     * The type of the object that is blocking another record.
081     *
082     * @return the type of the object that is blocking, should never be null
083     */
084    Class<?> getBlockingDataObjectClass();
085
086
087    /**
088     * Returns the human-meaningful name of the relationship
089     *
090     * @return relationship label
091     */
092    String getRelationshipLabel();
093}