ibi.broker.api.data.schedule
Class TimeInfoYear

java.lang.Object
  ibi.broker.api.data.schedule.TimeInfo
      ibi.broker.api.data.schedule.TimeInfoDay
          ibi.broker.api.data.schedule.TimeInfoYear

All Implemented Interfaces:

java.io.Serializable

public class TimeInfoYear
extends TimeInfoDay

 The TimeInfoYear class represents time information pertaining to scheduled  
 reports that run in intervals of years. This class fully extends the
 TimeInfoDay class and adds no additional methods. Like all time-related classes in 
 ReportCaster it is ultimately derived from the TimeInfo class.
 A code snippet illustrating the use of this class is below:

 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 +  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 TimeInfoYear so it can be referenced by a schedule.
                TimeInfoYear timeInfo = new TimeInfoYear();
                GregorianCalendar startTime = new GregorianCalendar();
                timeInfo.setStartTime(startTime);
                GregorianCalendar endTime = new GregorianCalendar();
                endTime.add(Calendar.YEAR, 4); //add 4 years to today as an end time
                timeInfo.setEndTime(endTime);
                timeInfo.setFrequency(1); //run every year
                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

TimeInfoYear()

Method Summary

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

getEndTime, getFrequency, getSecondaryRunInterval, setEndTime, setFrequency, setSecondaryRunInterval

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

TimeInfoYear

public TimeInfoYear()