Class PeriodGroupReference

java.lang.Object
COM.TIBCO.hawk.config.rbengine.schedule.PeriodGroupReference
All Implemented Interfaces:
Scheduleable

public class PeriodGroupReference extends 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.
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an PeriodGroupReference with the specified name.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a copy of this PeriodGroupReference.
    boolean
    Compares the specified object with this PeriodGroupReference.
    Returns the name the PeriodGroup of this PeriodGroupReference is referenced to.
    boolean
    Check to see if this PeriodGroupReference is in schedule based on passed GregorianCalendar.
    void
    Sets the name the PeriodGroup of this PeriodGroupReference is referenced to.
    toString(int iType)
    Returns a string reprensentation of this PeriodGroupReference.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • PeriodGroupReference

      public PeriodGroupReference(String name)
      Creates an PeriodGroupReference with the specified name.
  • Method Details

    • setName

      public void setName(String name)
      Sets the name the PeriodGroup of this PeriodGroupReference is referenced to.
    • getName

      public 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(Object o)
      Compares the specified object with this PeriodGroupReference.

      Overrides:
      equals in class Object
      Parameters:
      o - Object to compare.
      Returns:
      true if objects are equal, false otherwise.
    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a copy of this PeriodGroupReference.
      Overrides:
      clone in class Object
      Returns:
      a copy of this PeriodGroupReference.
      Throws:
      CloneNotSupportedException
    • toString

      public String toString(int iType)
      Returns a string reprensentation of this PeriodGroupReference.
    • inSchedule

      public boolean inSchedule(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.