Package hec.model
Class SchedulableJob
java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.model.SchedulableJob
- All Implemented Interfaces:
AsciiSerializable
,FieldAccessor
,Serializable
,Cloneable
,Comparable
,Observer
,Modifiable
- Direct Known Subclasses:
ScriptJob
base class for jobs that can be scheduled with the Scheduler
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
Fields inherited from class hec.lang.NamedType
_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
equals
(SchedulableJob thatJob) boolean
getFieldObject
(Field fld) This method allows access to java.lang.reflect.Field objects within the implementing class.long
int
int
int
getUser()
boolean
void
boolean
setFieldObject
(Field fld, Object fobj) This allows access to fields withing the implementing object to set there data.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
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
-
Field Details
-
MINUTE_INTERVAL
- See Also:
-
HOUR_INTERVAL
- See Also:
-
DAY_INTERVAL
- See Also:
-
SINGLE
- See Also:
-
-
Constructor Details
-
SchedulableJob
public SchedulableJob() -
SchedulableJob
-
-
Method Details
-
setRecurring
public void setRecurring(boolean b) -
setStartDate
-
isRecurring
public boolean isRecurring() -
getStartDateString
-
getStartDate
-
getRecurringAmount
public int getRecurringAmount() -
getRecurringInterval
public int getRecurringInterval() -
getIntervalString
-
setUser
-
getUser
-
setPassword
-
getPassword
-
setRecurringAmount
set the recurring amount. amount must be greater than 0 throws IllegalArgumentException if amount < 1- Throws:
IllegalArgumentException
-
setRecurringInterval
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
Description copied from interface:FieldAccessor
This method allows access to java.lang.reflect.Field objects within the implementing class.- Specified by:
getFieldObject
in interfaceFieldAccessor
- Overrides:
getFieldObject
in classNamedType
- Parameters:
fld
- The field to get.- Returns:
- The data object that is stored in the given field
-
setFieldObject
Description copied from interface:FieldAccessor
This allows access to fields withing the implementing object to set there data.- Specified by:
setFieldObject
in interfaceFieldAccessor
- Overrides:
setFieldObject
in classNamedType
- Parameters:
fld
- The java field object representing the member field to be setfobj
- The data to set in that field- Returns:
- returns true if successful
-
printInfo
public void printInfo() -
equals
-
equals
-