KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > services > scheduler > FixedDelayTaskConfiguration


1 /*
2  * The contents of this file are subject to the Sapient Public License
3  * Version 1.0 (the "License"); you may not use this file except in compliance
4  * with the License. You may obtain a copy of the License at
5  * http://carbon.sf.net/License.html.
6  *
7  * Software distributed under the License is distributed on an "AS IS" basis,
8  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9  * the specific language governing rights and limitations under the License.
10  *
11  * The Original Code is The Carbon Component Framework.
12  *
13  * The Initial Developer of the Original Code is Sapient Corporation
14  *
15  * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16  */
17
18 package org.sape.carbon.services.scheduler;
19
20 /**
21  * This is the configuration interface used to create fixed delay tasks within
22  * the Scheduler Service. See java.util.Timer for a definition of fixed delay.
23  *
24  * @see java.util.Timer#schedule(java.util.TimerTask, java.util.Date, long)
25  *
26  * Copyright 2002 Sapient
27  * @since carbon 1.0
28  * @author Douglas Voet, June 2002
29  * @version $Revision: 1.5 $($Author: dvoet $ / $Date: 2003/05/05 21:21:33 $)
30  */
31 public interface FixedDelayTaskConfiguration extends BaseTaskConfiguration {
32
33     /**
34      * InitialDelay is the length of time in milliseconds before this task
35      * will execute for the first time. This attribute is optional and will
36      * default to 0.
37      */
38     long InitialDelay = 0;
39
40     /**
41      * InitialDelay is the length of time in milliseconds before this task
42      * will execute for the first time. This attribute is optional and will
43      * default to 0.
44      *
45      * @return value of the initial delay
46      */
47     long getInitialDelay();
48
49     /**
50      * InitialDelay is the length of time in milliseconds before this task
51      * will execute for the first time. This attribute is optional and will
52      * default to 0.
53      *
54      * @param delay value of the initial delay
55      */
56     void setInitialDelay(long delay);
57
58     /**
59      * Period specifies how often the task will execute (in milliseconds)
60      *
61      * @return the period
62      */
63     long getPeriod();
64
65     /**
66      * Period specifies how often the task will execute (in milliseconds)
67      *
68      * @param period the period
69      */
70     void setPeriod(long period);
71 }
72
Popular Tags