View Javadoc

1   /**
2    * Copyright 2005-2013 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   * Common interface for all objects that can be configured in the dictionary
20   *
21   * @author Kuali Rice Team (rice.collab@kuali.org)
22   */
23  public interface DictionaryBean {
24  
25      /**
26       * Namespace code (often an application or module code) that dictionary bean is associated with
27       *
28       * <p>
29       * Note this may be assigned through the bean definition itself, or associated by the module configuration
30       * and its dictionary files
31       * </p>
32       *
33       * @return String namespace code
34       */
35      public String getNamespaceCode();
36  
37      /**
38       * A code within the namespace that identifies a component or group the bean is associated with
39       *
40       * @return String representing a component code
41       */
42      public String getComponentCode();
43  }