Schedule (TIBCO HAWK CONFIGURATION API)

java.lang.Object
- COM.TIBCO.hawk.config.rbengine.schedule.Schedule

All Implemented Interfaces:

java.lang.Cloneable
```
public class Schedule
extends java.lang.Object
implements java.lang.Cloneable
```
A Schedule is configuration object that can be used to determine if a rulebase or part of the rulebase should be in-schedule or out-of-schedule at a given time. A Schedule can be specified in any rulebase element such as Rulebase, Rule, Test, or an Action. When an element of the rulebase is out-of-schedule, that element and all its nodes are out-of-schedule. For example, if a Test is out-of-schedule, then the Test and all its actions are out-of-schedule. When a rulebase element is out-of-schedule, the rulebase element is suspended and will not be be active until the element is back in-schedule.
A Schedule has a name, a list of inclusion periods and a list of exclusion periods. A Schedule is in-schedule if at least one of its inclusion periods is in-schedule and none of its exclusion periods are in-schedule. If a Schedule does not have any inclusion period, then it is in-schedule if none of its exclusion periods are in-schedule. If a Schedule does not have any inclusion period or exclusion period, then it is out-of-schedule.
The inclusion periods and exclusion periods may contain Period or PeriodGroupReference objects.

Please refer

COM.TIBCO.hawk.config.rbengine.schedule, Schedules, Scheduleable, Period, PeriodGroup, PeriodGroupReference

Constructor Summary

Constructors
Constructor and Description
`Schedule(java.lang.String name)` Creates a schedule with the specified name.
`Schedule(java.lang.String name, Scheduleable[] inclusionPeriods, Scheduleable[] exclusionPeriods)` Deprecated.
`Schedule(java.lang.String name, java.util.Vector inclusionPeriods, java.util.Vector exclusionPeriods)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addExclusionPeriod(Scheduleable period)` Adds an period to existing a list of exclusion periods.
`void`	`addInclusionPeriod(Scheduleable period)` Adds an inclusion periods to existing a list of inclusion periods.
`java.lang.Object`	`clone()` Returns a copy of this Schedule.
`boolean`	`equals(java.lang.Object o)` Compares with the specified schedule for equality.
`Scheduleable[]`	`getExclusionPeriods()` Returns all exclusion periods in this Schedule.
`java.util.Vector`	`getExclusionPeriodsAsVector()` Deprecated.
`Scheduleable[]`	`getInclusionPeriods()` Returns all inclusion periods in this Schedule.
`java.util.Vector`	`getInclusionPeriodsAsVector()` Deprecated.
`java.lang.String`	`getName()` Returns the name of the schedule.
`long`	`getSecondTillNextScheduleChange()` Returns seconds until next schedule change.
`java.lang.String`	`getTimeZone()` Returns the TimeZone for this schedule.
`boolean`	`inSchedule(java.util.Date date)` Checks to see if the schedule is in-schedule using the specified date.
`boolean`	`isUsingPeriodGroup(java.lang.String periodGroupName)` Checks if the specified PeriodGroup is used by this schedules.
`void`	`removeExclusionPeriod(Scheduleable period)` Removes an period from existing a list of exclusion periods.
`void`	`removeInclusionPeriod(Scheduleable period)` Removes an period from existing a list of inclusion periods.
`void`	`setExclusionPeriods(java.util.Vector periods)` Deprecated.
`void`	`setInclusionPeriods(java.util.Vector periods)` Deprecated.
`void`	`setName(java.lang.String name)` Sets the name of the Schedule.
`void`	`setTimeZone(java.lang.String timeZone)` Sets the timezone of the Schedule.
`java.lang.String`	`toString()` Returns a string representation of the Schedule object.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Schedule
```
public Schedule(java.lang.String name)
```
    Creates a schedule with the specified name. The new Schedule does not has any inclusion or exclusion period.
    
    Parameters:
    
    name - the schedule name
  - Schedule
```
public Schedule(java.lang.String name,
                Scheduleable[] inclusionPeriods,
                Scheduleable[] exclusionPeriods)
```
    Deprecated.
    
    Creates a schedule with the specified name, inclusion periods, and exclusion periods.
    
    Parameters:
    
    name - the schedule name
    
    inclusionPeriods - a list of inclusion Period or PeriodGroupReference
    
    exclusionPeriods - a list of exclusion Period or PeriodGroupReference
    
    Throws:
    
    java.lang.IllegalArgumentException - if name, inclusionPeriods or inclusionPeriods is null
  - Schedule
```
public Schedule(java.lang.String name,
                java.util.Vector inclusionPeriods,
                java.util.Vector exclusionPeriods)
```
    Deprecated.
    
    Creates a schedule with the specified name, inclusion periods, and exclusion periods.
    
    Parameters:
    
    name - the schedule name
    
    inclusionPeriods - a list of inclusion Period or PeriodGroupReference
    
    exclusionPeriods - a list of exclusion Period or PeriodGroupReference
    
    Throws:
    
    java.lang.IllegalArgumentException - if name, inclusionPeriods or inclusionPeriods is null
- Method Detail
  - inSchedule
```
public boolean inSchedule(java.util.Date date)
```
    Checks to see if the schedule is in-schedule using the specified date.
    
    Parameters:
    
    date - date to be checked.
    
    Returns:
    
    true if date is in-schedule.
  - getSecondTillNextScheduleChange
```
public long getSecondTillNextScheduleChange()
```
    Returns seconds until next schedule change. If the next schedule is after mid night (12:00 am), then seconds till mid night is returned.
    
    Returns:
    
    seconds until next schedule change.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the Schedule.
    
    Throws:
    
    java.lang.IllegalArgumentException - if name is null
  - getName
```
public java.lang.String getName()
```
    Returns the name of the schedule.
  - setTimeZone
```
public void setTimeZone(java.lang.String timeZone)
```
    Sets the timezone of the Schedule.
    Note: In 4.7, timezone can be set to null. If timezone is null, local timezone is used for the schedule.
  - getTimeZone
```
public java.lang.String getTimeZone()
```
    Returns the TimeZone for this schedule.
  - setInclusionPeriods
```
public void setInclusionPeriods(java.util.Vector periods)
```
    Deprecated.
    
    Replaces current inclusion periods in this Schedule with the given list.
  - getInclusionPeriods
```
public Scheduleable[] getInclusionPeriods()
```
    Returns all inclusion periods in this Schedule.
  - getInclusionPeriodsAsVector
```
public java.util.Vector getInclusionPeriodsAsVector()
```
    Deprecated.
    
    Returns a list of inclusion periods.
  - setExclusionPeriods
```
public void setExclusionPeriods(java.util.Vector periods)
```
    Deprecated.
    
    Replaces current inclusion periods in this Schedule with the given list.
  - getExclusionPeriods
```
public Scheduleable[] getExclusionPeriods()
```
    Returns all exclusion periods in this Schedule.
  - getExclusionPeriodsAsVector
```
public java.util.Vector getExclusionPeriodsAsVector()
```
    Deprecated.
    
    Returns a list of exclusion periods.
  - addInclusionPeriod
```
public void addInclusionPeriod(Scheduleable period)
```
    Adds an inclusion periods to existing a list of inclusion periods.
    
    Parameters:
    
    period - Period or PeriodGroupReference to be added.
    
    Throws:
    
    java.lang.IllegalArgumentException - if period is null
  - addExclusionPeriod
```
public void addExclusionPeriod(Scheduleable period)
```
    Adds an period to existing a list of exclusion periods.
    
    Parameters:
    
    period - Period or PeriodGroupReference to be added.
    
    Throws:
    
    java.lang.IllegalArgumentException - if period is null
  - removeInclusionPeriod
```
public void removeInclusionPeriod(Scheduleable period)
```
    Removes an period from existing a list of inclusion periods.
  - removeExclusionPeriod
```
public void removeExclusionPeriod(Scheduleable period)
```
    Removes an period from existing a list of exclusion periods.
  - isUsingPeriodGroup
```
public boolean isUsingPeriodGroup(java.lang.String periodGroupName)
```
    Checks if the specified PeriodGroup is used by this schedules.
    
    Returns:
    
    true if this Schedule use the given PeriodGroup.
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Returns a copy of this Schedule.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compares with the specified schedule for equality. Note that two Schedule objects with identical inclusion and exclusion periods but with different comments and last modification string are consider equals.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the Schedule to be compared.
    
    Returns:
    
    true if the Schedule objects are equal.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the Schedule object.
    
    Overrides:
    
    toString in class java.lang.Object

Class Schedule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Schedule

Schedule

Schedule

Method Detail

inSchedule

getSecondTillNextScheduleChange

setName

getName

setTimeZone

getTimeZone

setInclusionPeriods

getInclusionPeriods

getInclusionPeriodsAsVector

setExclusionPeriods

getExclusionPeriods

getExclusionPeriodsAsVector

addInclusionPeriod

addExclusionPeriod

removeInclusionPeriod

removeExclusionPeriod

isUsingPeriodGroup

clone

equals

toString