ibi.broker.api.data.schedule
Class TimeInfoWeek

java.lang.Object
  ibi.broker.api.data.schedule.TimeInfo
      ibi.broker.api.data.schedule.TimeInfoMinute
          ibi.broker.api.data.schedule.TimeInfoWeek

All Implemented Interfaces:

java.io.Serializable

public class TimeInfoWeek
extends TimeInfoMinute

 The TimeInfoWeek class represents time information pertaining to scheduled  
 reports that run in intervals of weeks. This class fully extends the
 TimeInfoMinute class and adds no methods or fields. Like all time-related classes in 
 ReportCaster, it is ultimately derived from the TimeInfo class.
 A code example illustrating the use of this class is as follows:
 The code snippet below illustrates the use of TimeInfoWeek.

 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 +  Copyright (c) 2004 Information Builders, Inc. All  Rights Reserved.     +
 +                                                                          +
 +  Information Builders offers sample API programs as a heuristic device.  +
 +  They are not intended, as is, for production use. Licensed users are    +
 +  welcome to alter and extend these samples and deploy them in other      +
 +  environments, or alternate configurations, as they see fit.             +
 +  Information Builders will support the documented functionality of       +
 +  its API classes and methods. However, Information Builders is not       +
 +  responsible for functionality or behavior of products built with        +
 +  its API unless the documented behavior of its discrete classes and      +
 +  methods is different than the actual results.                           +
 +                                                                          +
 +  Redistributions of IBI source code and documentation must be within     +
 +  the scope of the Information Builders Software License Agreement.       +
 +                                                                          +
 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++   

 //create TimeInfoWeek for reference by a schedule.
                TimeInfoWeek timeInfo = new TimeInfoWeek();
                GregorianCalendar startTime = new GregorianCalendar();
                timeInfo.setStartTime(startTime);//start at current time. this is also the default.
                GregorianCalendar endTime = new GregorianCalendar();
                endTime.add(Calendar.DATE, 45); //run this schedule for 45 days
    timeInfo.setEndTime(endTime);
                timeInfo.setMonday(true);
                timeInfo.setTuesday(false);
                timeInfo.setWednesday(false);
                timeInfo.setThursday(false);
                timeInfo.setFriday(true);
                timeInfo.setSaturday(false);
                timeInfo.setSunday(false);
                timeInfo.setEndTime(endTime);
                timeInfo.setFrequency(2); //this schedule runs Monday and Friday every two weeks
                schedule.setTimeInfo(timeInfo);
 

See Also:

Serialized Form

Field Summary

Fields inherited from class ibi.broker.api.data.schedule.TimeInfo

CUSTOM, DAY, description, HOUR, id, MINUTE, MONTH, name, ONCE, WEEK, YEAR

Constructor Summary

TimeInfoWeek()

Method Summary

TimeInterval	getSecondaryRunInterval() Obtains the secondary run interval, in minutes.
void	setSecondaryRunInterval(TimeInterval secondaryRunInterval) Assigns the secondary run interval, in minutes.

Methods inherited from class ibi.broker.api.data.schedule.TimeInfoMinute

getEndTime, getFrequency, isFriday, isMonday, isSaturday, isSunday, isThursday, isTuesday, isWednesday, setEndTime, setFrequency, setFriday, setMonday, setSaturday, setSunday, setThursday, setTuesday, setWednesday

Methods inherited from class ibi.broker.api.data.schedule.TimeInfo

getDescription, getId, getName, getNextRunTime, getStartTime, setDescription, setId, setName, setNextRunTime, setStartTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeInfoWeek

public TimeInfoWeek()

Method Detail

getSecondaryRunInterval

public TimeInterval getSecondaryRunInterval()

Obtains the secondary run interval, in minutes. You can optionally create a secondary run interval for a schedule within the day the schedule runs. Apply the secondary run interval every n minutes for a specified number of minutes or until a specified time. This option is available for schedules that run every day(s), week(s), month(s), or year(s).

Returns:

The secondary run interval, as a TimeInterval.

See Also:

setSecondaryRunInterval(TimeInterval)

setSecondaryRunInterval

public void setSecondaryRunInterval(TimeInterval secondaryRunInterval)

Assigns the secondary run interval, in minutes. You can optionally create a secondary run interval for a schedule within the day the schedule runs. Apply the secondary run interval every n minutes for a specified number of minutes or until a specified time. This option is available for schedules that run every day(s), week(s), month(s), or year(s).

Parameters:

secondaryRunInterval - The secondary run interval, in minutes.

See Also:

getSecondaryRunInterval()