org.sape.carbon.services.scheduler
Interface FixedDelayTaskConfiguration

All Superinterfaces:
BaseTaskConfiguration, Configuration

public interface FixedDelayTaskConfiguration
extends BaseTaskConfiguration

This is the configuration interface used to create fixed delay tasks within the Scheduler Service. See java.util.Timer for a definition of fixed delay.

Since:
carbon 1.0
Version:
$Revision: 1.5 $($Author: dvoet $ / $Date: 2003/05/05 21:21:33 $)
Author:
Douglas Voet, June 2002
See Also:
Copyright 2002 Sapient

Field Summary
static long InitialDelay
          InitialDelay is the length of time in milliseconds before this task will execute for the first time.
 
Method Summary
 long getInitialDelay()
          InitialDelay is the length of time in milliseconds before this task will execute for the first time.
 long getPeriod()
          Period specifies how often the task will execute (in milliseconds)
 void setInitialDelay(long delay)
          InitialDelay is the length of time in milliseconds before this task will execute for the first time.
 void setPeriod(long period)
          Period specifies how often the task will execute (in milliseconds)
 
Methods inherited from interface org.sape.carbon.services.scheduler.BaseTaskConfiguration
getSchedulableComponent, getScheduledMethod, setSchedulableComponent, setScheduledMethod
 
Methods inherited from interface org.sape.carbon.core.config.Configuration
clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly
 

Field Detail

InitialDelay

public static final long InitialDelay
InitialDelay is the length of time in milliseconds before this task will execute for the first time. This attribute is optional and will default to 0.

See Also:
Constant Field Values
Method Detail

getInitialDelay

public long getInitialDelay()
InitialDelay is the length of time in milliseconds before this task will execute for the first time. This attribute is optional and will default to 0.

Returns:
value of the initial delay

setInitialDelay

public void setInitialDelay(long delay)
InitialDelay is the length of time in milliseconds before this task will execute for the first time. This attribute is optional and will default to 0.

Parameters:
delay - value of the initial delay

getPeriod

public long getPeriod()
Period specifies how often the task will execute (in milliseconds)

Returns:
the period

setPeriod

public void setPeriod(long period)
Period specifies how often the task will execute (in milliseconds)

Parameters:
period - the period


Copyright 1999-2003 Sapient Corporation. All Rights Reserved.