Package hec.model

Class SchedulableJob

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.model.SchedulableJob

All Implemented Interfaces:

hec.io.AsciiSerializable, Serializable, Cloneable, Comparable, Observer, Modifiable

Direct Known Subclasses:

ScriptJob

public abstract class SchedulableJob
extends NamedType
implements Serializable, hec.io.AsciiSerializable

base class for jobs that can be scheduled with the Scheduler

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DAY_INTERVAL
static final String	HOUR_INTERVAL
static final String	MINUTE_INTERVAL
static final String	SINGLE

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Constructor Summary

Constructors

Constructor	Description
SchedulableJob()
SchedulableJob(String jobName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(SchedulableJob thatJob)
boolean	equals(Object that)
Object	getFieldObject(Field fld)
String	getIntervalString()
String	getPassword()
long	getPeriod()
int	getRecurringAmount()
int	getRecurringInterval()
Date	getStartDate()
String	getStartDateString()
int	getTimezoneOffset()
String	getUser()
boolean	isRecurring()
void	printInfo()
boolean	setFieldObject(Field fld, Object fobj)
void	setPassword(String password)
void	setRecurring(boolean b)
void	setRecurringAmount(int amount)	set the recurring amount.
void	setRecurringInterval(String interval)	set the recurring interval.
void	setStartDate(String startDate)
void	setTimezoneOffset(int offset)
void	setUser(String user)

Methods inherited from class hec.lang.NamedType

addModifiableListener, clone, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, toString, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

MINUTE_INTERVAL

public static final String MINUTE_INTERVAL

See Also:

• Constant Field Values

HOUR_INTERVAL

public static final String HOUR_INTERVAL

See Also:

• Constant Field Values

DAY_INTERVAL

public static final String DAY_INTERVAL

See Also:

• Constant Field Values

SINGLE

public static final String SINGLE

See Also:

• Constant Field Values

Constructor Details

SchedulableJob

public SchedulableJob()

SchedulableJob

public SchedulableJob(String jobName)

Method Details

setRecurring

public void setRecurring(boolean b)

setStartDate

public void setStartDate(String startDate)

isRecurring

public boolean isRecurring()

getStartDateString

public String getStartDateString()

getStartDate

public Date getStartDate()

getRecurringAmount

public int getRecurringAmount()

getRecurringInterval

public int getRecurringInterval()

getIntervalString

public String getIntervalString()

setUser

public void setUser(String user)

getUser

public String getUser()

setPassword

public void setPassword(String password)

getPassword

public String getPassword()

setRecurringAmount

public void setRecurringAmount(int amount)
                        throws IllegalArgumentException

set the recurring amount. amount must be greater than 0 throws IllegalArgumentException if amount < 1

Throws:

IllegalArgumentException

setRecurringInterval

public void setRecurringInterval(String interval)
                          throws IllegalArgumentException

set the recurring interval. Currently supports Hour or Day throws IllegalArgumentException if interval isn't Hour or Day.

Throws:

IllegalArgumentException

getPeriod

public long getPeriod()

setTimezoneOffset

public void setTimezoneOffset(int offset)

getTimezoneOffset

public int getTimezoneOffset()

getFieldObject

public Object getFieldObject(Field fld)

Specified by:

getFieldObject in interface hec.io.AsciiSerializable

Overrides:

getFieldObject in class NamedType

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Specified by:

setFieldObject in interface hec.io.AsciiSerializable

Overrides:

setFieldObject in class NamedType

printInfo

public void printInfo()

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(SchedulableJob thatJob)