1 /* ====================================================================
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 2003 Digital Clash LLC. All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * ChronicJ team (http://www.chronicj.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "ChronicJ" and "Digital Clash" not be used to endorse or
27 * promote products derived from this software without prior written
28 * permission. For written permission, please contact
29 * info@digitalclash.com.
30 *
31 * 5. Products derived from this software may not be called "ChronicJ",
32 * "Digital Clash", nor may "ChronicJ" or "Digital Clash" appear in
33 * their name, without prior written permission of Digital Clash LLC.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 * This product includes software developed by the by the
49 * Apache Software Foundation (http://www.apache.org/).
50 * ====================================================================
51 */
52 package org.chronicj;
53
54
55 /***
56 * <p>
57 * Encapsulates the information and behaviour for specific {@link
58 * org.chronicj.Event Event}s in the context of a {@link
59 * org.chronicj.Schedule}.
60 * </p>
61 *
62 * <p>
63 * This class is based directly on patterns described in a paper by Martin
64 * Fowler which can be found <a
65 * href="http://martinfowler.com/apsupp/recurring.pdf">here</a>.
66 * </p>
67 *
68 * @author <a href="mlipper@US-ABP.com">Matthew Lipper</a>
69 *
70 * @see <a href="http://martinfowler.com/apsupp/recurring.pdf">Recurring Events
71 * for Calendars</a>
72 */
73 public interface ScheduleElement {
74 /***
75 * Determines if a given event occurs during a particular instant in time.
76 *
77 * @param anEvent the Event
78 * @param aTimePoint the moment in time
79 *
80 * @return a boolean value indicating whether the event occurs during the specified TimePoint
81 */
82 public boolean isOccuring(Event anEvent, TimePoint aTimePoint);
83
84 /***
85 * Determines if a given event occurs within a particular data range.
86 *
87 * @param anEvent the Event whose schedule is being queried
88 * @param aDateRange the time period in which to check
89 *
90 * @return a boolean value indicating whether the event occurs within the specified DateRange
91 */
92 public boolean isOccuring(Event anEvent, DateRange aDateRange);
93 }
This page was automatically generated by Maven