|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bpe.api.TimerSpecification
public final class TimerSpecification
Describes options that can be used to set timers.
For example, you can use this specification when
rescheduling
the expiration time
of a waiting activity.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
static TimerSpecification |
TIMER_SPECIFICATION_IMMEDIATE
An out-of-the-box timer specification that can be used as a timer that is triggered immediately. |
static TimerSpecification |
TIMER_SPECIFICATION_INFINITE
An out-of-the-box timer specification that can be used as a timer that is never triggered. |
static int |
TYPE_DEADLINE
Symbolic constant for the type of a timer specification that uses a deadline. |
static int |
TYPE_DURATION
Symbolic constant for the type of a timer specification that uses a duration. |
static int |
TYPE_IMMEDIATE
Symbolic constant for the type of a timer specification that is triggered immediately. |
static int |
TYPE_INFINITE
Symbolic constant for the type of a timer specification that is never triggered, that is, no timer is set up. |
static int |
TYPE_TIMEOUT
Symbolic constant for the type of a timer specification that uses a timeout. |
Constructor Summary | |
---|---|
TimerSpecification()
Default constructor that sets up an infinite time, that is, no timer is set up. |
|
TimerSpecification(java.util.Calendar deadline)
Constructor that uses a deadline as timer specification. |
|
TimerSpecification(java.lang.Integer duration)
Constructor that uses a duration as timer specification. |
|
TimerSpecification(java.lang.String timeoutExpression,
java.lang.String calendarName,
java.lang.String JNDINameOfCalendar)
Constructor that uses a timeout expression as timer specification. |
Method Summary | |
---|---|
java.lang.String |
getCalendarName()
Returns the name of the calendar used for the timeout expression. |
java.util.Calendar |
getDeadline()
Returns the deadline specification. |
java.lang.Integer |
getDuration()
Returns the duration specification in seconds. |
java.lang.String |
getJNDINameOfCalendar()
Returns the JNDI name of a user-defined calendar used for the timeout expression. |
java.lang.String |
getTimeoutExpression()
Returns a calendar specific timeout expression. |
int |
getType()
Returns the type of the timer specification. |
java.lang.String |
toString()
Returns a string representation of the TimerSpecification object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final int TYPE_IMMEDIATE
public static final int TYPE_DURATION
public static final int TYPE_DEADLINE
public static final int TYPE_TIMEOUT
public static final int TYPE_INFINITE
public static final TimerSpecification TIMER_SPECIFICATION_IMMEDIATE
public static final TimerSpecification TIMER_SPECIFICATION_INFINITE
Constructor Detail |
---|
public TimerSpecification()
public TimerSpecification(java.lang.Integer duration) throws EngineParameterNullException
duration
- The duration in seconds that may pass until, for example, an activity instance expires.
EngineParameterNullException
public TimerSpecification(java.util.Calendar deadline) throws EngineParameterNullException
deadline
- The time up to which an object is in some state, for example, the time an
activity instance is waiting for an event. When the specified
time has been reached, the object changes its state.
For example, a waiting activity continues navigation, that is, returns to
the running state.
EngineParameterNullException
public TimerSpecification(java.lang.String timeoutExpression, java.lang.String calendarName, java.lang.String JNDINameOfCalendar) throws EngineParameterNullException
timeoutExpression
- A calendar specific expression that is used to calculate the time up to when
an object is in some state. When the specified
time has been reached, the object changes its state.
For example, a waiting activity continues navigation, that is, returns to
the running state.calendarName
- The name of a user-provided calendar. If the JNDI name of the calendar is not
specified, the name may be "SIMPLE" or "CRON" to select one of WebSphere's
calendars. If neither a calendar name nor a JNDI name is specified, then the WebSphere
default calendar (SIMPLE) is used.JNDINameOfCalendar
- The JNDI name of the EJB providing the user's calendar; may be null so that
one of WebSphere's calendars is used.
EngineParameterNullException
Method Detail |
---|
public java.lang.Integer getDuration()
public java.util.Calendar getDeadline()
public java.lang.String getTimeoutExpression()
For details on calendars refer to the WebSphere Application Server documentation.
public java.lang.String getCalendarName()
getJNDINameOfCalendar
.
For details on calendars refer to the WebSphere Application Server documentation.
public java.lang.String getJNDINameOfCalendar()
getCalendarName
.
For details on calendars refer to the WebSphere Application Server documentation.
public int getType()
public java.lang.String toString()
toString
in class java.lang.Object
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |