KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.sape.carbon.core.component.FunctionalInterface;
21 import org.sape.carbon.core.config.Configuration;
22
23 /**
24  * Basic configuration required by all tasks
25  *
26  * @since carbon 1.0
27  * @author Douglas Voet, Jul 26, 2002
28  * @version $Revision: 1.6 $($Author: ghinkl $ / $Date: 2003/10/17 06:35:45 $)
29  * <br>Copyright 2002 Sapient
30  */

31 public interface BaseTaskConfiguration extends Configuration {
32
33     /**
34      * SchedulableComponent is the name of the component that will be
35      * called by this task. If the component does not implement Schedulable
36      * the ScheduledMethod field must also be set.
37      *
38      * @return component that is called by this task
39      */

40     FunctionalInterface getSchedulableComponent();
41
42     /**
43      * SchedulableComponent is the name of the component that will be
44      * called by this task. If the component does not implement Schedulable
45      * the ScheduledMethod field must also be set.
46      *
47      * @param component component that is called by this task
48      */

49     void setSchedulableComponent(FunctionalInterface component);
50
51
52     /**
53      * The scheduled method can be used to execute any no-argument method on
54      * any type of carbon component.
55      * @since 2.1
56      * @return the name of the no-argument method to execute.
57      */

58     String JavaDoc getScheduledMethod();
59
60     /**
61      * Sets the name of the component method to execute.
62      * @since 2.1
63      * @param scheduledMethod the name of the method to schedule.
64      */

65     void setScheduledMethod(String JavaDoc scheduledMethod);
66 }
67
Popular Tags