com.oakgrovesystems.reactor.processMediation
Class TimerSpec

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.processMediation.TimerSpec
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class TimerSpec
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

A specification that can be used to start a timer in the Reactor Timer Service.

See Also:
Serialized Form

Field Summary
protected  java.lang.String calendar
           
protected  java.lang.String description
           
protected  java.util.Date endDate
           
protected  java.lang.String endExpression
           
protected  com.oakgrovesystems.reactor.ReactorEvent event
           
protected  int repeatCount
           
protected  java.lang.String repeatExpression
           
protected  java.util.Date scheduleDate
           
protected  java.lang.String scheduleExpression
           
 
Constructor Summary
TimerSpec()
          Creates a TimerSpec with all properties set to null or 0.
 
Method Summary
 java.lang.Object clone()
           
 java.lang.String getCalendar()
           
 java.lang.String getDescription()
           
 java.util.Date getEndDate()
           
 java.lang.String getEndExpression()
           
 com.oakgrovesystems.reactor.ReactorEvent getEvent()
           
 int getRepeatCount()
           
 java.lang.String getRepeatExpression()
           
 java.util.Date getScheduleDate()
           
 java.lang.String getScheduleExpression()
           
 boolean sameAs(com.oakgrovesystems.reactor.processMediation.TimerSpec other)
           
 void setCalendar(java.lang.String calendar)
           
 void setDescription(java.lang.String description)
           
 void setEndDate(java.util.Date endDate)
          Only one of repeatCount, endDate, and endExpression can be set.
 void setEndExpression(java.lang.String endExpression)
          Only one of repeatCount, endDate, and endExpression can be set.
 void setEvent(com.oakgrovesystems.reactor.ReactorEvent event)
          Sets the ReactorEvent that will be fired when the Timer expires.
 void setRepeatCount(int repeatCount)
          Only one of repeatCount, endDate, and endExpression can be set.
 void setRepeatExpression(java.lang.String repeatExpression)
           
 void setScheduleDate(java.util.Date scheduleDate)
          A scheduleDate and scheduleExpression can not both be set.
 void setScheduleExpression(java.lang.String scheduleExpression)
          A scheduleDate and scheduleExpression can not both be set.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

scheduleDate

protected java.util.Date scheduleDate

scheduleExpression

protected java.lang.String scheduleExpression

repeatExpression

protected java.lang.String repeatExpression

repeatCount

protected int repeatCount

endDate

protected java.util.Date endDate

endExpression

protected java.lang.String endExpression

calendar

protected java.lang.String calendar

description

protected java.lang.String description

event

protected com.oakgrovesystems.reactor.ReactorEvent event
Constructor Detail

TimerSpec

public TimerSpec()
Creates a TimerSpec with all properties set to null or 0. Such a timer expires one time- immediately. Before this timer can be started, it must be associated with a ReactorEvent to be fired when the timer expires.

Method Detail

getScheduleDate

public java.util.Date getScheduleDate()

setScheduleDate

public void setScheduleDate(java.util.Date scheduleDate)
A scheduleDate and scheduleExpression can not both be set. Setting one to a non-null value sets the other to null.

Parameters:
scheduleDate - the scheduleDate

getScheduleExpression

public java.lang.String getScheduleExpression()

setScheduleExpression

public void setScheduleExpression(java.lang.String scheduleExpression)
A scheduleDate and scheduleExpression can not both be set. Setting one to a non-null value sets the other to null.

Parameters:
scheduleExpression - the scheduleExpression

getRepeatExpression

public java.lang.String getRepeatExpression()

setRepeatExpression

public void setRepeatExpression(java.lang.String repeatExpression)

getRepeatCount

public int getRepeatCount()

setRepeatCount

public void setRepeatCount(int repeatCount)
Only one of repeatCount, endDate, and endExpression can be set. Setting one to a non-null value sets the other two to null or -1.

Parameters:
repeatCount - the repeatCount

getEndDate

public java.util.Date getEndDate()

setEndDate

public void setEndDate(java.util.Date endDate)
Only one of repeatCount, endDate, and endExpression can be set. Setting one to a non-null value sets the other two to null or -1.

Parameters:
endDate - the endDate

getEndExpression

public java.lang.String getEndExpression()

setEndExpression

public void setEndExpression(java.lang.String endExpression)
Only one of repeatCount, endDate, and endExpression can be set. Setting one to a non-null value sets the other two to null or -1.

Parameters:
endExpression - the endExpression

getCalendar

public java.lang.String getCalendar()

setCalendar

public void setCalendar(java.lang.String calendar)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getEvent

public com.oakgrovesystems.reactor.ReactorEvent getEvent()

setEvent

public void setEvent(com.oakgrovesystems.reactor.ReactorEvent event)
Sets the ReactorEvent that will be fired when the Timer expires.

Parameters:
event - the ReactorEvent that will be fired when the timer expires.

sameAs

public boolean sameAs(com.oakgrovesystems.reactor.processMediation.TimerSpec other)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Overrides:
clone in class java.lang.Object
java.lang.CloneNotSupportedException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.