1 /**
2 * Copyright 2010 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the
5 * "License"); you may not use this file except in compliance with the
6 * License. You may obtain a copy of the License at
7 *
8 * http://www.osedu.org/licenses/ECL-2.0
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
13 * implied. See the License for the specific language governing
14 * permissions and limitations under the License.
15 */
16
17 package org.kuali.student.r2.common.infc;
18
19 /**
20 * Captures space and time information associated with a meeting or
21 * event.
22 *
23 * @author Kuali Student Team (Kamal)
24 */
25
26 // TODO: This interface should eventually move into the scheduling
27 // service domain
28
29 public interface MeetingSchedule
30 extends HasId {
31
32 /**
33 * Space code where the meeting is going to take place.
34 *
35 * @name Space Code
36 */
37 public String getSpaceId();
38
39 /**
40 * Date and Time The date and time values for all vCalendar properties are
41 * formatted as a string consistent with the ISO 8601 representation for
42 * combinations of dates and times. Either the basic or extended format is
43 * allowed. The use of UTC, rather than local time, should be used when ever
44 * possible in order to avoid time zone ambiguities. The format for the
45 * complete, basic representation of a date and time value is written in the
46 * following sequence of characters:
47 * <year><month><day>T<hour><minute<second><type designator> For example,
48 * 8:30 AM on April 15, 1996 local time would be written as: 19960415T083000
49 * And the same time in UTC based time would be written as: 19960415T083000Z
50 * Where a value needs to specify a sequence of date and time values, then
51 * the property value is a string made up of a list of date and time values,
52 * separated by the field separator. For example: 19960101T090000Z;
53 * 19960201T090000Z; 19960301T090000Z; 19960401T090000Z; ... Time Duration
54 * The values for time duration or periods of time for all vCalendar
55 * properties are formatted as a string conformant with the ISO 8601 basic
56 * representation for duration of time. A given duration of a period of time
57 * is represented by a character string consisting of the designator "P",
58 * optionally including the number of years followed by the designator "Y",
59 * optionally including the number of months followed by the designator "M",
60 * optionally including the number of weeks followed by the designator "W",
61 * optionally including the number of days followed by the designator "D".
62 * The sequence can also contain a time component preceded by the designator
63 * "T", optionally including the number of hours followed by the designator
64 * "H", optionally including the number of minutes followed by the
65 * designator "M", optionally including the number of seconds followed by
66 * the designator "S". For example: P6W A period of six weeks; PT15M A
67 * period of 15 minutes; PT1H30M A period of 1 hour and thirty minutes; or
68 * P2Y10M15DT10H30M20S A period of 2 years, 10 months, 15 days, 10 hours, 30
69 * minutes, and 20 seconds.
70 *
71 * @name Schedule Id
72 */
73 public String getScheduleId();
74 }