1 /*
2 * Copyright 2011 The Kuali Foundation Licensed under the
3 * Educational Community License, Version 2.0 (the "License"); you may
4 * not use this file except in compliance with the License. You may
5 * obtain a copy of the License at
6 *
7 * http://www.osedu.org/licenses/ECL-2.0
8 *
9 * Unless required by applicable law or agreed to in writing,
10 * software distributed under the License is distributed on an "AS IS"
11 * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12 * or implied. See the License for the specific language governing
13 * permissions and limitations under the License.
14 */
15
16 package org.kuali.student.r2.lum.clu.infc;
17
18 import org.kuali.student.r2.common.infc.Relationship;
19
20 /**
21 * Detailed information about a CLU to CLU relationship.
22 *
23 * @Version 2.0
24 * @Author Sri komandur@uw.edu
25 */
26 public interface CluCluRelation extends Relationship {
27 /**
28 * Unique identifier for a Canonical Learning Unit (CLU).
29 *
30 * @name Clu Id
31 * @readOnly
32 * @required
33 */
34 public String getCluId();
35
36 /**
37 * Unique identifier for a Canonical Learning Unit (CLU).
38 *
39 * @name Related Clu Id
40 * @readOnly
41 * @required
42 */
43 public String getRelatedCluId();
44
45 /**
46 * Indicates if the relation is required upon instantiation of a LUI.
47 * Default is "true".
48 *
49 * @name Is Clu Relation Required
50 */
51 public Boolean getIsCluRelationRequired();
52 }