01: /*--
02:
03: Copyright (C) 2002-2005 Adrian Price.
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09:
10: 1. Redistributions of source code must retain the above copyright
11: notice, this list of conditions, and the following disclaimer.
12:
13: 2. Redistributions in binary form must reproduce the above copyright
14: notice, this list of conditions, and the disclaimer that follows
15: these conditions in the documentation and/or other materials
16: provided with the distribution.
17:
18: 3. The names "OBE" and "Open Business Engine" must not be used to
19: endorse or promote products derived from this software without prior
20: written permission. For written permission, please contact
21: adrianprice@sourceforge.net.
22:
23: 4. Products derived from this software may not be called "OBE" or
24: "Open Business Engine", nor may "OBE" or "Open Business Engine"
25: appear in their name, without prior written permission from
26: Adrian Price (adrianprice@users.sourceforge.net).
27:
28: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
29: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
32: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
33: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
34: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
37: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38: POSSIBILITY OF SUCH DAMAGE.
39:
40: For more information on OBE, please see
41: <http://obe.sourceforge.net/>.
42:
43: */
44:
45: package org.obe.spi.runtime;
46:
47: import org.obe.xpdl.model.misc.DurationUnit;
48:
49: import java.util.Date;
50:
51: /**
52: * Provides date arithmetic services based on a business calendar. It provides
53: * stateless versions of the date arithmetic methods of
54: * <code>java.util.Calendar</code>.
55: *
56: * @author Adrian Price
57: */
58: public interface BusinessCalendar {
59: // TODO: Check out cron expressions for time calculations.
60:
61: /**
62: * Wraps the Calendar Date Arithmetic function. Adds the specified (signed)
63: * amount of time to the given time field, based on the calendar's rules.
64: *
65: * @param base The base date.
66: * @param field The JDK calendar field code.
67: * @param interval The amount of date or time to be added to the field.
68: * @param user The (optional) user name for which the computation is being
69: * performed. Calendar implementations can use this information to ensure
70: * that temporal computations take proper account of a user's time zone.
71: * @return The result of the date computation.
72: */
73: Date add(Date base, int field, int interval, String user);
74:
75: /**
76: * Wraps the Calendar Date Arithmetic function. Adds the specified (signed)
77: * amount of time using the given duration unit, based on the calendar's
78: * rules.
79: *
80: * @param base The base date.
81: * @param unit The XPDL duration unit to use.
82: * @param interval The amount of date or time to be added to the field.
83: * @param user The (optional) user name for which the computation is being
84: * performed. Calendar implementations can use this information to ensure
85: * that temporal computations take proper account of a user's time zone.
86: * @return The result of the date computation.
87: */
88: Date add(Date base, DurationUnit unit, int interval, String user);
89: }
|