View Javadoc

1   /**
2    * Copyright 2005-2014 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.datadictionary;
17  
18  /**
19   * This interface provides read-only metadata about inactivation blocking.  This metadata object is associated with a
20   * business object.
21   * The source of this information often comes from the data dictionary file.
22   *
23   * @author Kuali Rice Team (rice.collab@kuali.org)
24   */
25  public interface InactivationBlockingMetadata {
26  
27      /**
28       * The property name of the reference that is blocked
29       */
30      public String getBlockedReferencePropertyName();
31  
32      /**
33       * The type of the object that is blocked
34       *
35       * @return
36       */
37      public Class getBlockedBusinessObjectClass();
38  
39      /**
40       * The bean name of the service that is responsible for determining whether there are any records that block
41       * inactivation
42       */
43      public String getInactivationBlockingDetectionServiceBeanName();
44  
45      /**
46       * The type of the object that is blocking another record
47       */
48      public Class getBlockingReferenceBusinessObjectClass();
49  
50      /**
51       * Returns the human-meaningful name of the relationship
52       *
53       * @return
54       */
55      public String getRelationshipLabel();
56  }