001/**
002 * Copyright 2005-2018 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 java.io.Serializable;
019
020/**
021 * Common interface for all objects that can be configured in the dictionary
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public interface DictionaryBean extends Serializable {
026
027    /**
028     * Namespace code (often an application or module code) that dictionary bean is associated with
029     *
030     * <p>
031     * Note this may be assigned through the bean definition itself, or associated by the module configuration
032     * and its dictionary files
033     * </p>
034     *
035     * @return String namespace code
036     */
037    public String getNamespaceCode();
038
039    /**
040     * A code within the namespace that identifies a component or group the bean is associated with
041     *
042     * @return String representing a component code
043     */
044    public String getComponentCode();
045
046    /**
047     * Perform any needed post-processing of the bean properties.  This will be called
048     * starting at the parent data object entry or document entry class and recursed down
049     * though all other DictionaryBean objects contained within.
050     */
051    public void dataDictionaryPostProcessing();
052}