|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TimerType
A representation of the model object 'Timer Type'. The timerType specifies an enterprise bean timer. Each timer is automatically created by the container upon deployment. Timer callbacks occur based on the schedule attributes. All callbacks are made to the timeout-method associated with the timer. A timer can have an optional start and/or end date. If a start date is specified, it takes precedence over the associated timer schedule such that any matching expirations prior to the start time will not occur. Likewise, no matching expirations will occur after any end date. Start/End dates are specified using the XML Schema dateTime type, which follows the ISO-8601 standard for date(and optional time-within-the-day) representation. An optional flag can be used to control whether this timer has persistent(true) delivery semantics or non-persistent(false) delivery semantics. If not specified, the value defaults to persistent(true). A time zone can optionally be associated with a timer. If specified, the timer's schedule is evaluated in the context of that time zone, regardless of the default time zone in which the container is executing. Time zones are specified as an ID string. The set of required time zone IDs is defined by the Zone Name(TZ) column of the public domain zoneinfo database. An optional info string can be assigned to the timer and retrieved at runtime through the Timer.getInfo() method. The timerType can only be specified on stateless session beans, singleton session beans, and message-driven beans.
The following features are supported:
EjbJar31Package.getTimerType()
Method Summary | |
---|---|
|
getDescription()
Returns the value of the 'Description' containment reference list. |
javax.xml.datatype.XMLGregorianCalendar |
getEnd()
Returns the value of the 'End' attribute. |
java.lang.String |
getId()
Returns the value of the 'Id' attribute. |
String |
getInfo()
Returns the value of the 'Info' containment reference. |
TrueFalseType |
getPersistent()
Returns the value of the 'Persistent' containment reference. |
TimerScheduleType |
getSchedule()
Returns the value of the 'Schedule' containment reference. |
javax.xml.datatype.XMLGregorianCalendar |
getStart()
Returns the value of the 'Start' attribute. |
NamedMethodType |
getTimeoutMethod()
Returns the value of the 'Timeout Method' containment reference. |
String |
getTimezone()
Returns the value of the 'Timezone' containment reference. |
void |
setEnd(javax.xml.datatype.XMLGregorianCalendar value)
Sets the value of the ' End ' attribute. |
void |
setId(java.lang.String value)
Sets the value of the ' Id ' attribute. |
void |
setInfo(String value)
Sets the value of the ' Info ' containment reference. |
void |
setPersistent(TrueFalseType value)
Sets the value of the ' Persistent ' containment reference. |
void |
setSchedule(TimerScheduleType value)
Sets the value of the ' Schedule ' containment reference. |
void |
setStart(javax.xml.datatype.XMLGregorianCalendar value)
Sets the value of the ' Start ' attribute. |
void |
setTimeoutMethod(NamedMethodType value)
Sets the value of the ' Timeout Method ' containment reference. |
void |
setTimezone(String value)
Sets the value of the ' Timezone ' containment reference. |
Method Detail |
---|
getDescription()
DescriptionType
.
If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...
EjbJar31Package.getTimerType_Description()
TimerScheduleType getSchedule()
If the meaning of the 'Schedule' containment reference isn't clear, there really should be more of a description here...
setSchedule(TimerScheduleType)
,
EjbJar31Package.getTimerType_Schedule()
void setSchedule(TimerScheduleType value)
Schedule
' containment reference.
value
- the new value of the 'Schedule' containment reference.getSchedule()
javax.xml.datatype.XMLGregorianCalendar getStart()
If the meaning of the 'Start' attribute isn't clear, there really should be more of a description here...
setStart(XMLGregorianCalendar)
,
EjbJar31Package.getTimerType_Start()
void setStart(javax.xml.datatype.XMLGregorianCalendar value)
Start
' attribute.
value
- the new value of the 'Start' attribute.getStart()
javax.xml.datatype.XMLGregorianCalendar getEnd()
If the meaning of the 'End' attribute isn't clear, there really should be more of a description here...
setEnd(XMLGregorianCalendar)
,
EjbJar31Package.getTimerType_End()
void setEnd(javax.xml.datatype.XMLGregorianCalendar value)
End
' attribute.
value
- the new value of the 'End' attribute.getEnd()
NamedMethodType getTimeoutMethod()
If the meaning of the 'Timeout Method' containment reference isn't clear, there really should be more of a description here...
setTimeoutMethod(NamedMethodType)
,
EjbJar31Package.getTimerType_TimeoutMethod()
void setTimeoutMethod(NamedMethodType value)
Timeout Method
' containment reference.
value
- the new value of the 'Timeout Method' containment reference.getTimeoutMethod()
TrueFalseType getPersistent()
If the meaning of the 'Persistent' containment reference isn't clear, there really should be more of a description here...
setPersistent(TrueFalseType)
,
EjbJar31Package.getTimerType_Persistent()
void setPersistent(TrueFalseType value)
Persistent
' containment reference.
value
- the new value of the 'Persistent' containment reference.getPersistent()
String getTimezone()
If the meaning of the 'Timezone' containment reference isn't clear, there really should be more of a description here...
setTimezone(org.eclipse.modisco.jee.ejbjar.EjbJar31.String)
,
EjbJar31Package.getTimerType_Timezone()
void setTimezone(String value)
Timezone
' containment reference.
value
- the new value of the 'Timezone' containment reference.getTimezone()
String getInfo()
If the meaning of the 'Info' containment reference isn't clear, there really should be more of a description here...
setInfo(org.eclipse.modisco.jee.ejbjar.EjbJar31.String)
,
EjbJar31Package.getTimerType_Info()
void setInfo(String value)
Info
' containment reference.
value
- the new value of the 'Info' containment reference.getInfo()
java.lang.String getId()
If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...
setId(String)
,
EjbJar31Package.getTimerType_Id()
void setId(java.lang.String value)
Id
' attribute.
value
- the new value of the 'Id' attribute.getId()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |