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 import java.io.Serializable;
19
20 /**
21 * Common interface for all objects that can be configured in the dictionary
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 */
25 public interface DictionaryBean extends Serializable {
26
27 /**
28 * Namespace code (often an application or module code) that dictionary bean is associated with
29 *
30 * <p>
31 * Note this may be assigned through the bean definition itself, or associated by the module configuration
32 * and its dictionary files
33 * </p>
34 *
35 * @return String namespace code
36 */
37 public String getNamespaceCode();
38
39 /**
40 * A code within the namespace that identifies a component or group the bean is associated with
41 *
42 * @return String representing a component code
43 */
44 public String getComponentCode();
45
46 /**
47 * Perform any needed post-processing of the bean properties. This will be called
48 * starting at the parent data object entry or document entry class and recursed down
49 * though all other DictionaryBean objects contained within.
50 */
51 public void dataDictionaryPostProcessing();
52 }