org.sape.carbon.services.scheduler
Interface BaseTaskConfiguration

All Superinterfaces:

Configuration

All Known Subinterfaces:

FixedDelayTaskConfiguration, FixedRateTaskConfiguration

public interface BaseTaskConfiguration

extends Configuration

Basic configuration required by all tasks

Since:

carbon 1.0

Version:

$Revision: 1.6 $($Author: ghinkl $ / $Date: 2003/10/17 06:35:45 $)
Copyright 2002 Sapient

Author:

Douglas Voet, Jul 26, 2002

Method Summary

FunctionalInterface	getSchedulableComponent() SchedulableComponent is the name of the component that will be called by this task.
String	getScheduledMethod() The scheduled method can be used to execute any no-argument method on any type of carbon component.
void	setSchedulableComponent(FunctionalInterface component) SchedulableComponent is the name of the component that will be called by this task.
void	setScheduledMethod(String scheduledMethod) Sets the name of the component method to execute.

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Method Detail

getSchedulableComponent

public 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.

Returns:

component that is called by this task

setSchedulableComponent

public void setSchedulableComponent(FunctionalInterface component)

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.

Parameters:

component - component that is called by this task

getScheduledMethod

public String getScheduledMethod()

The scheduled method can be used to execute any no-argument method on any type of carbon component.

Returns:

the name of the no-argument method to execute.

Since:

2.1

setScheduledMethod

public void setScheduledMethod(String scheduledMethod)

Sets the name of the component method to execute.

Parameters:

scheduledMethod - the name of the method to schedule.

Since:

2.1