Package hec.model

Class SchedulableJob

All Implemented Interfaces:
AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable
Direct Known Subclasses:
ScriptJob

public abstract class SchedulableJob extends NamedType implements Serializable, AsciiSerializable
base class for jobs that can be scheduled with the Scheduler
See Also:
  • Field Details

  • 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)
      Description copied from interface: FieldAccessor
      This method allows access to java.lang.reflect.Field objects within the implementing class.
      Specified by:
      getFieldObject in interface FieldAccessor
      Overrides:
      getFieldObject in class NamedType
      Parameters:
      fld - The field to get.
      Returns:
      The data object that is stored in the given field
    • setFieldObject

      public boolean setFieldObject(Field fld, Object fobj)
      Description copied from interface: FieldAccessor
      This allows access to fields withing the implementing object to set there data.
      Specified by:
      setFieldObject in interface FieldAccessor
      Overrides:
      setFieldObject in class NamedType
      Parameters:
      fld - The java field object representing the member field to be set
      fobj - The data to set in that field
      Returns:
      returns true if successful
    • printInfo

      public void printInfo()
    • equals

      public boolean equals(Object that)
      Overrides:
      equals in class Object
    • equals

      public boolean equals(SchedulableJob thatJob)