public class PeriodGroup extends java.lang.Object implements Scheduleable, java.lang.Cloneable
PeriodGroupReference
added to inclusion or exclusion periods of a schedule.
A PeriodGroup is in-schedule only if all of its periods are in-schedule. Otherwise, a PeriodGroup is out-of-schedule.
Constructor and Description |
---|
PeriodGroup(java.lang.String name)
Creates an empty PeriodGroup with the specified name.
|
PeriodGroup(java.lang.String name,
Period[] periods)
Creates a PeriodGroup with specified name and periods.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Returns a copy of this PeriodGroup.
|
boolean |
equals(java.lang.Object o)
Compares the specified object with this PeriodGroup.
|
java.lang.String |
getName()
Returns the name of this PeriodGroup.
|
Period[] |
getPeriods()
Returns the periods in this PeriodGroup.
|
boolean |
inSchedule(java.util.GregorianCalendar gc)
Checks to see if this PeriodGroup is in schedule based on the specified GregorianCalendar.
|
void |
setName(java.lang.String name)
Sets the name this PeriodGroup.
|
void |
setPeriods(Period[] periods)
Replaces the periods in this PeriodGroup with the specified periods.
|
java.lang.String |
toString(int iType)
Returns a string reprensentation of this PeriodGroup.
|
public PeriodGroup(java.lang.String name)
public PeriodGroup(java.lang.String name, Period[] periods) throws ScheduleException
ScheduleException
- if invalid periods are specified.public void setName(java.lang.String name)
public java.lang.String getName()
public void setPeriods(Period[] periods) throws ScheduleException
periods
- an array of Periods .ScheduleException
- if invalid periods are specified.public Period[] getPeriods()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- Object to compare.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public java.lang.String toString(int iType)
public boolean inSchedule(java.util.GregorianCalendar gc)
inSchedule
in interface Scheduleable
gc
- GregorianCalendar for checking if this PeriodGroup is in schedule.Copyright © 2000-2019 TIBCO Inc. All Rights Reserved.