01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/course-management/tags/sakai_2-4-1/cm-api/api/src/java/org/sakaiproject/coursemanagement/api/CanonicalCourse.java $
03: * $Id: CanonicalCourse.java 20104 2007-01-04 19:24:04Z jholtzman@berkeley.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.coursemanagement.api;
21:
22: import java.util.Set;
23:
24: /**
25: * A CanonicalCourse represents the aspects of a course that stay the same across
26: * instances of a course. A CanonicalCourse exists whether there are any instances
27: * of the course or not.
28: *
29: * @author <a href="mailto:jholtzman@berkeley.edu">Josh Holtzman</a>
30: */
31: public interface CanonicalCourse {
32:
33: /**
34: * A unique enterprise id
35: * @return
36: */
37: public String getEid();
38:
39: public void setEid(String eid);
40:
41: /**
42: * What authority defines this object?
43: * @return
44: */
45: public String getAuthority();
46:
47: public void setAuthority(String authority);
48:
49: /**
50: * The title
51: * @return
52: */
53: public String getTitle();
54:
55: public void setTitle(String title);
56:
57: /**
58: * A description
59: * @return
60: */
61: public String getDescription();
62:
63: public void setDescription(String description);
64:
65: /**
66: * Gets the Set <String> of course set EIDs that contain this canonical course.
67: * @return
68: */
69: public Set<String> getCourseSetEids();
70: }
|