i-net Clear Reports

com.inet.report.schedule
Class WeeklyExecution

java.lang.Object
  extended by com.inet.report.schedule.ScheduleExecution
      extended by com.inet.report.schedule.WeeklyExecution
All Implemented Interfaces:
ExecutionTimeProvider

public class WeeklyExecution
extends ScheduleExecution

An ExecutionTimeProvider which would be described in the form "Run the task every ___ weeks on _____, ____, and ____ at ____ o'clock." To create a WeeklyExecution object, use createWeeklyExecution from the class ScheduleExecutionFactory.
Once created, you can set the "week step size" (every ___ days) and the specific days of the week (on ___ and ___) in addition to changing time of day and hour range, methods in the super class ScheduleExecution.

Since:
6.0
See Also:
OneDayExecution, DailyExecution, MonthlyExecution, ScheduleExecutionFactory, ScheduleExecution, ExecutionTimeProvider

Nested Class Summary
 
Nested classes/interfaces inherited from class com.inet.report.schedule.ScheduleExecution
ScheduleExecution.WeekDay, ScheduleExecution.WeekIndex
 
Method Summary
 int[] getSpecificDays()
          Returns the specific days set for this object either during creation of the object or with the method setSpecificDays.
 int getWeekStepSize()
          Returns the week step size set for this object.
 void setSpecificDays(int[] specificDays)
          Sets the specific days of the week to run the task in a chosen week.
 void setWeekStepSize(int weekStepSize)
          Sets the week step size for this execution time provider - the value must be 1 or greater.
 
Methods inherited from class com.inet.report.schedule.ScheduleExecution
getEndDate, getHour, getHourRange, getLoopCount, getMinute, getNextExecutionTime, getStartDate, setEndDate, setHourRange, setHourRange, setLoopCount, setStartDate, setStartTime
 

Method Detail

setWeekStepSize

public void setWeekStepSize(int weekStepSize)
                     throws ScheduleException
Sets the week step size for this execution time provider - the value must be 1 or greater.

Parameters:
weekStepSize - The week step size for this execution time provider
Throws:
ScheduleException - If the weekStepSize is less than 1.

setSpecificDays

public void setSpecificDays(int[] specificDays)
                     throws ScheduleException
Sets the specific days of the week to run the task in a chosen week. One-based, starting on Monday. E.g. "Monday, Wednesday, and Sunday" would be the int array {1,3,7}.

Parameters:
specificDays - The specific days of the week
Throws:
ScheduleException - If the array is null or empty, or if one of the days is not between 1 and 7.

getWeekStepSize

public int getWeekStepSize()
Returns the week step size set for this object.

Returns:
The week step size set for this object.

getSpecificDays

public int[] getSpecificDays()
Returns the specific days set for this object either during creation of the object or with the method setSpecificDays.

Returns:
The specific days set for this object

i-net Clear Reports

Copyright © 1999-2015 by i-net software GmbH