01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/course-management/tags/sakai_2-4-1/cm-api/api/src/java/org/sakaiproject/coursemanagement/api/AcademicSession.java $
03: * $Id: AcademicSession.java 13837 2006-08-18 00:41:43Z 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.Date;
23:
24: /**
25: * <p>
26: * An institutional context for CourseOfferings, distinguishing one instance of
27: * a CanonicalCourse from another. In higher educational institutions, it almost always
28: * includes a time range. However, self-paced "sessions" are apparently also
29: * possible.
30: * </p>
31: *
32: * <p>
33: * AcademicSession includes a notion of ordering and currency to support queries
34: * such as "Find all current course offerings" and "Sort past course offerings
35: * in reverse session order".
36: * </p>
37: * @author <a href="mailto:jholtzman@berkeley.edu">Josh Holtzman</a>
38: */
39: public interface AcademicSession {
40: /**
41: * A unique enterprise id
42: * @return
43: */
44: public String getEid();
45:
46: public void setEid(String eid);
47:
48: /**
49: * What authority defines this object?
50: * @return
51: */
52: public String getAuthority();
53:
54: public void setAuthority(String authority);
55:
56: /**
57: * The title
58: * @return
59: */
60: public String getTitle();
61:
62: public void setTitle(String title);
63:
64: /**
65: * A description
66: * @return
67: */
68: public String getDescription();
69:
70: public void setDescription(String description);
71:
72: /**
73: * The date this AcademicSession starts (if any).
74: * @return
75: */
76: public Date getStartDate();
77:
78: public void setStartDate(Date startDate);
79:
80: /**
81: * The date this AcademicSession ends (if any).
82: * @return
83: */
84: public Date getEndDate();
85:
86: public void setEndDate(Date endDate);
87: }
|