ibi.broker.api.data.schedule
Class TimeInfoHour

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

All Implemented Interfaces:

java.io.Serializable

public class TimeInfoHour
extends TimeInfoMinute

 The TimeInfoHour class represents time information pertaining to scheduled  
 reports that run in intervals of hours. It is a full extension of the TimeInfoMinute
 class and adds no fields or methods. 
 Like all time-related classes in ReportCaster it is ultimately derived from
 the TimeInfo class. 
 The code snippet below illustrates the use of TimeInfoHour.

 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 +  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 TimeInfoHour for reference by a schedule.
                TimeInfoHour timeInfo = new TimeInfoHour();
                GregorianCalendar startTime = new GregorianCalendar();
                timeInfo.setStartTime(startTime);//start at current time. this is also the default.
                GregorianCalendar endTime = new GregorianCalendar();
                endTime.add(Calendar.DATE, 15); //run this schedule for 15 days
                timeInfo.setEndTime(endTime);
                timeInfo.setFrequency(3); //run this schedule every 3 hours 
                timeInfo.setMonday(true);
                timeInfo.setTuesday(true);
                timeInfo.setWednesday(true);
                timeInfo.setThursday(true);
                timeInfo.setFriday(true);
                timeInfo.setSaturday(false);//don't run on Saturday or Sunday
                timeInfo.setSunday(false);
                schedule.setTimeInfo(timeInfo);
 

Version:

5.3

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

TimeInfoHour()

Method Summary

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

TimeInfoHour

public TimeInfoHour()