COM.TIBCO.hawk.config.rbengine.schedule

Class PeriodGroupReference

java.lang.Object

COM.TIBCO.hawk.config.rbengine.schedule.PeriodGroupReference

All Implemented Interfaces:

Scheduleable

public class PeriodGroupReference
extends java.lang.Object
implements Scheduleable

A PeriodGroupReference object references to a PeriodGroup in the Schedules. It can be used as a schedulable object in the inclusion or exclusion list of a Schedule.

Please refer

Schedule, PeriodGroup

Constructor Summary

Constructors

Constructor and Description
PeriodGroupReference(java.lang.String name) Creates an PeriodGroupReference with the specified name.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a copy of this PeriodGroupReference.
boolean	equals(java.lang.Object o) Compares the specified object with this PeriodGroupReference.
java.lang.String	getName() Returns the name the PeriodGroup of this PeriodGroupReference is referenced to.
boolean	inSchedule(java.util.GregorianCalendar gc) Check to see if this PeriodGroupReference is in schedule based on passed GregorianCalendar.
void	setName(java.lang.String name) Sets the name the PeriodGroup of this PeriodGroupReference is referenced to.
java.lang.String	toString(int iType) Returns a string reprensentation of this PeriodGroupReference.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeriodGroupReference

public PeriodGroupReference(java.lang.String name)

Creates an PeriodGroupReference with the specified name.

Method Detail

setName

public void setName(java.lang.String name)

Sets the name the PeriodGroup of this PeriodGroupReference is referenced to.

getName

public java.lang.String getName()

Returns the name the PeriodGroup of this PeriodGroupReference is referenced to.

Returns:

the name the PeriodGroup of this PeriodGroupReference is referenced to.

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this PeriodGroupReference.

Overrides:

equals in class java.lang.Object

Parameters:

o - Object to compare.

Returns:

true if objects are equal, false otherwise.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a copy of this PeriodGroupReference.

Overrides:

clone in class java.lang.Object

Returns:

a copy of this PeriodGroupReference.

Throws:

java.lang.CloneNotSupportedException

toString

public java.lang.String toString(int iType)

Returns a string reprensentation of this PeriodGroupReference.

inSchedule

public boolean inSchedule(java.util.GregorianCalendar gc)

Check to see if this PeriodGroupReference is in schedule based on passed GregorianCalendar. The call is passed to the referenced PeriodGroup.

Specified by:

inSchedule in interface Scheduleable

Parameters:

gc - GregorianCalendar for checking if this PeriodGroupReference is in schedule.

Returns:

true if this PeriodGroupReference is in schedule.