/*
* The contents of this file are subject to the Sapient Public License
* Version 1.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* http://carbon.sf.net/License.html.
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The Original Code is The Carbon Component Framework.
*
* The Initial Developer of the Original Code is Sapient Corporation
*
* Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
*/
package org.sape.carbon.services.scheduler;
import org.sape.carbon.core.component.FunctionalInterface;
import org.sape.carbon.core.config.Configuration;
/**
* Basic configuration required by all tasks
*
* @since carbon 1.0
* @author Douglas Voet, Jul 26, 2002
* @version $Revision: 1.6 $($Author: ghinkl $ / $Date: 2003/10/17 06:35:45 $)
* <br>Copyright 2002 Sapient
*/
public interface BaseTaskConfiguration extends Configuration {
/**
* SchedulableComponent is the name of the component that will be
* called by this task. If the component does not implement Schedulable
* the ScheduledMethod field must also be set.
*
* @return component that is called by this task
*/
FunctionalInterface getSchedulableComponent();
/**
* SchedulableComponent is the name of the component that will be
* called by this task. If the component does not implement Schedulable
* the ScheduledMethod field must also be set.
*
* @param component component that is called by this task
*/
void setSchedulableComponent(FunctionalInterface component);
/**
* The scheduled method can be used to execute any no-argument method on
* any type of carbon component.
* @since 2.1
* @return the name of the no-argument method to execute.
*/
String getScheduledMethod();
/**
* Sets the name of the component method to execute.
* @since 2.1
* @param scheduledMethod the name of the method to schedule.
*/
void setScheduledMethod(String scheduledMethod);
}
|