org.eclipse.modisco.jee.ejbjar.EjbJar31
Interface TimerType


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:

See Also:
EjbJar31Package.getTimerType()
Generated:
Model:
extendedMetaData="name='timerType' kind='elementOnly'"

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

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference list.
See Also:
EjbJar31Package.getTimerType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/javaee'"

getSchedule

TimerScheduleType getSchedule()
Returns the value of the 'Schedule' containment reference.

If the meaning of the 'Schedule' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Schedule' containment reference.
See Also:
setSchedule(TimerScheduleType), EjbJar31Package.getTimerType_Schedule()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='schedule' namespace='http://java.sun.com/xml/ns/javaee'"

setSchedule

void setSchedule(TimerScheduleType value)
Sets the value of the 'Schedule' containment reference.

Parameters:
value - the new value of the 'Schedule' containment reference.
See Also:
getSchedule()
Generated:

getStart

javax.xml.datatype.XMLGregorianCalendar getStart()
Returns the value of the 'Start' attribute.

If the meaning of the 'Start' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Start' attribute.
See Also:
setStart(XMLGregorianCalendar), EjbJar31Package.getTimerType_Start()
Generated:
Model:
dataType="org.eclipse.emf.ecore.xml.type.DateTime" extendedMetaData="kind='element' name='start' namespace='http://java.sun.com/xml/ns/javaee'"

setStart

void setStart(javax.xml.datatype.XMLGregorianCalendar value)
Sets the value of the 'Start' attribute.

Parameters:
value - the new value of the 'Start' attribute.
See Also:
getStart()
Generated:

getEnd

javax.xml.datatype.XMLGregorianCalendar getEnd()
Returns the value of the 'End' attribute.

If the meaning of the 'End' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'End' attribute.
See Also:
setEnd(XMLGregorianCalendar), EjbJar31Package.getTimerType_End()
Generated:
Model:
dataType="org.eclipse.emf.ecore.xml.type.DateTime" extendedMetaData="kind='element' name='end' namespace='http://java.sun.com/xml/ns/javaee'"

setEnd

void setEnd(javax.xml.datatype.XMLGregorianCalendar value)
Sets the value of the 'End' attribute.

Parameters:
value - the new value of the 'End' attribute.
See Also:
getEnd()
Generated:

getTimeoutMethod

NamedMethodType getTimeoutMethod()
Returns the value of the 'Timeout Method' containment reference.

If the meaning of the 'Timeout Method' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Timeout Method' containment reference.
See Also:
setTimeoutMethod(NamedMethodType), EjbJar31Package.getTimerType_TimeoutMethod()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='timeout-method' namespace='http://java.sun.com/xml/ns/javaee'"

setTimeoutMethod

void setTimeoutMethod(NamedMethodType value)
Sets the value of the 'Timeout Method' containment reference.

Parameters:
value - the new value of the 'Timeout Method' containment reference.
See Also:
getTimeoutMethod()
Generated:

getPersistent

TrueFalseType getPersistent()
Returns the value of the 'Persistent' containment reference.

If the meaning of the 'Persistent' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Persistent' containment reference.
See Also:
setPersistent(TrueFalseType), EjbJar31Package.getTimerType_Persistent()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='persistent' namespace='http://java.sun.com/xml/ns/javaee'"

setPersistent

void setPersistent(TrueFalseType value)
Sets the value of the 'Persistent' containment reference.

Parameters:
value - the new value of the 'Persistent' containment reference.
See Also:
getPersistent()
Generated:

getTimezone

String getTimezone()
Returns the value of the 'Timezone' containment reference.

If the meaning of the 'Timezone' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Timezone' containment reference.
See Also:
setTimezone(org.eclipse.modisco.jee.ejbjar.EjbJar31.String), EjbJar31Package.getTimerType_Timezone()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='timezone' namespace='http://java.sun.com/xml/ns/javaee'"

setTimezone

void setTimezone(String value)
Sets the value of the 'Timezone' containment reference.

Parameters:
value - the new value of the 'Timezone' containment reference.
See Also:
getTimezone()
Generated:

getInfo

String getInfo()
Returns the value of the 'Info' containment reference.

If the meaning of the 'Info' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Info' containment reference.
See Also:
setInfo(org.eclipse.modisco.jee.ejbjar.EjbJar31.String), EjbJar31Package.getTimerType_Info()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='info' namespace='http://java.sun.com/xml/ns/javaee'"

setInfo

void setInfo(String value)
Sets the value of the 'Info' containment reference.

Parameters:
value - the new value of the 'Info' containment reference.
See Also:
getInfo()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), EjbJar31Package.getTimerType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: