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.dto.RichTextInfo;
19 import org.kuali.student.r2.common.infc.Relationship;
20
21 /**
22 * Information about the LU to document relation.
23 *
24 * @Version 2.0
25 * @Author Sri komandur@uw.edu
26 */
27 public interface LuDocRelation extends Relationship {
28 /**
29 * Unique identifier for a Canonical Learning Unit (CLU).
30 *
31 * @name Clu Id
32 * @readOnly
33 * @required
34 */
35 public String getCluId();
36
37 /**
38 * Unique identifier for a document.
39 *
40 * @name Document Id
41 * @readOnly
42 * @required
43 */
44 public String getDocumentId();
45
46 /**
47 * The title of the document usage in the context of the CLU.
48 *
49 * @name Title
50 */
51 public String getTitle();
52
53 /**
54 * The description of the document usage in the context of the CLU.
55 *
56 * @name Descr
57 */
58 public RichTextInfo getDescr();
59 }