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.krms.api.repository;
17
18 import org.kuali.rice.core.api.mo.common.Identifiable;
19 import org.kuali.rice.krms.api.repository.type.KrmsAttributeDefinitionContract;
20
21 /**
22 * Base interface intended for extension by other AttributeContract interfaces
23 * <p>This contains the common fields shared by all KRMS attributes.</p>
24 * @author Kuali Rice Team (rice.collab@kuali.org)
25 *
26 */
27 public interface BaseAttributeContract extends Identifiable {
28
29 /**
30 * Returns the id of the attribute definition.
31 *
32 * <p>
33 * The attribute definition contains metadata about the attribute. This
34 * is a required field and may not be null or blank. Many
35 * attribute instances may share the same attribute definition.
36 * </p>
37 * @return the attribute definition id
38 */
39 public String getAttributeDefinitionId();
40
41 /**
42 * Returns the value of the attribute
43 *
44 * @return the value of the attribute
45 */
46 public String getValue();
47
48 /**
49 * Returns a {@link KrmsAttributeDefinitionContract.}
50 * <p>This is the object referred to by the attributeDefinitionId.
51 * The full object is also kept here for performance purposes. This is because the name of the attribute
52 * is referenced often for resolving name / value attribute pairs.</p>
53 *
54 * @return the attribute definition
55 */
56 public KrmsAttributeDefinitionContract getAttributeDefinition();
57
58 }