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.kim.api.type.KimTypeContract;
22
23 /**
24 * This is the contract for a KimDataAttribute. A KimDataAttribute
25 * associates a value with a kim attribute.
26 */
27 public interface KimAttributeDataContract extends Identifiable, Versioned, GloballyUnique {
28
29 /**
30 * The id of the object this AttributeData is associated with. For
31 * example: this could be a permissionId, roleId, groupId, or
32 * responsibilityId.
33 *
34 * @return the id
35 */
36 String getAssignedToId();
37
38 /**
39 * The attribute value. This can be null or blank.
40 *
41 * @return the attribute value.
42 */
43 String getAttributeValue();
44
45 /**
46 * The kim attribute associated with the kim attribute data. This can be null if no KimAttributes are associated.
47 *
48 * @return the kim attribute
49 */
50 KimAttributeContract getKimAttribute();
51
52
53 /**
54 * The kim type id associated with the kim attribute data. This can be null if no kim types are associated.
55 *
56 * @return the kim type id
57 */
58 String getKimTypeId();
59
60 /**
61 * The kim type associated with the kim attribute data. This can be null if no kim types are associated.
62 *
63 * @return the kim type
64 */
65 KimTypeContract getKimType();
66 }