001    /**
002     * Copyright 2005-2013 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     */
016    package org.kuali.rice.kim.api.common.attribute;
017    
018    import org.kuali.rice.core.api.mo.common.GloballyUnique;
019    import org.kuali.rice.core.api.mo.common.Identifiable;
020    import org.kuali.rice.core.api.mo.common.Versioned;
021    import org.kuali.rice.core.api.mo.common.active.Inactivatable;
022    
023    /**
024     * This is the contract for a KimAttribute.  A KimAttribute
025     * associates categorizes an attribute and describes how to
026     * find the attribute for the purpose of the kns.
027     */
028    public interface KimAttributeContract extends Versioned, GloballyUnique, Identifiable, Inactivatable {
029    
030        /**
031         * A fully-qualified class name which contains the {@link #getAttributeName()}.    This cannot be null or a blank string.
032         *
033         * @return the name
034         */
035        String getComponentName();
036    
037        /**
038         * The name of the attribute on the {@link #getComponentName()}.   This cannot be null or a blank string.
039         *
040         * @return the name
041         */
042        String getAttributeName();
043    
044        /**
045         * The namespace code that this kim attribute belongs too.   This cannot be null or a blank string.
046         *
047         * @return namespace code
048         */
049        String getNamespaceCode();
050    
051        /**
052         * The label for the kim attribute.  This is optional and can be null or blank.
053         *
054         * @return the label
055         */
056        String getAttributeLabel();
057    }