1 /**
2 * Copyright 2005-2012 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.kim.api.common.attribute;
17
18 import org.kuali.rice.core.api.mo.common.GloballyUnique;
19 import org.kuali.rice.core.api.mo.common.Identifiable;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
22
23 /**
24 * This is the contract for a KimAttribute. A KimAttribute
25 * associates categorizes an attribute and describes how to
26 * find the attribute for the purpose of the kns.
27 */
28 public interface KimAttributeContract extends Versioned, GloballyUnique, Identifiable, Inactivatable {
29
30 /**
31 * A fully-qualified class name which contains the {@link #getAttributeName()}. This cannot be null or a blank string.
32 *
33 * @return the name
34 */
35 String getComponentName();
36
37 /**
38 * The name of the attribute on the {@link #getComponentName()}. This cannot be null or a blank string.
39 *
40 * @return the name
41 */
42 String getAttributeName();
43
44 /**
45 * The namespace code that this kim attribute belongs too. This cannot be null or a blank string.
46 *
47 * @return namespace code
48 */
49 String getNamespaceCode();
50
51 /**
52 * The label for the kim attribute. This is optional and can be null or blank.
53 *
54 * @return the label
55 */
56 String getAttributeLabel();
57 }