BEAST
eu.baltrad.beast.message.mo.BltTriggerJobMessage Class Reference

A message for triggering specific jobs/rules. More...

Inheritance diagram for eu.baltrad.beast.message.mo.BltTriggerJobMessage:
eu.baltrad.beast.message.IBltXmlMessage eu.baltrad.beast.message.IBltMessage

Public Member Functions

void fromDocument (Document dom)
 
Document toDocument ()
 
void setId (String id)
 
String getId ()
 
void setName (String name)
 
String getName ()
 
void setArgs (String[] args)
 
String[] getArgs ()
 
Date getScheduledFireTime ()
 
void setScheduledFireTime (Date scheduledFireTime)
 
Date getFireTime ()
 
void setFireTime (Date fireTime)
 
Date getNextFireTime ()
 
void setNextFireTime (Date nextFireTime)
 
Date getPrevFireTime ()
 
void setPrevFireTime (Date prevFireTime)
 

Static Public Attributes

static final String BLT_TRIGGER_JOB = "blttriggerjob"
 The static name of this message.
 

Protected Member Functions

void addDateStringAttribute (Element el, String attrname, Date date)
 Creates a UTC formatted date string.
 
Date convertToDate (String str)
 Converts a UTC formatted string (yyyy-MM-ddTHH:mm:ssZ) into a date object.
 

Detailed Description

A message for triggering specific jobs/rules.

In order to trigger a specific rule, the job name has to be specified otherwise the message will be propagated to all rules as usual.

Author
Anders Henja

Member Function Documentation

◆ addDateStringAttribute()

void eu.baltrad.beast.message.mo.BltTriggerJobMessage.addDateStringAttribute ( Element el,
String attrname,
Date date )
inlineprotected

Creates a UTC formatted date string.

Parameters
datethe date to format
Returns
the utc formatted string

◆ convertToDate()

Date eu.baltrad.beast.message.mo.BltTriggerJobMessage.convertToDate ( String str)
inlineprotected

Converts a UTC formatted string (yyyy-MM-ddTHH:mm:ssZ) into a date object.

Parameters
strthe utc formatted string
Returns
the date

◆ fromDocument()

void eu.baltrad.beast.message.mo.BltTriggerJobMessage.fromDocument ( Document dom)
inline

◆ getArgs()

String[] eu.baltrad.beast.message.mo.BltTriggerJobMessage.getArgs ( )
inline
Returns
the args

◆ getId()

String eu.baltrad.beast.message.mo.BltTriggerJobMessage.getId ( )
inline
Returns
the id

◆ getName()

String eu.baltrad.beast.message.mo.BltTriggerJobMessage.getName ( )
inline
Returns
the name

◆ setArgs()

void eu.baltrad.beast.message.mo.BltTriggerJobMessage.setArgs ( String[] args)
inline
Parameters
argsthe args to set

◆ setId()

void eu.baltrad.beast.message.mo.BltTriggerJobMessage.setId ( String id)
inline
Parameters
idthe id to set

◆ setName()

void eu.baltrad.beast.message.mo.BltTriggerJobMessage.setName ( String name)
inline
Parameters
namethe name to set

◆ toDocument()

Document eu.baltrad.beast.message.mo.BltTriggerJobMessage.toDocument ( )
inline

Member Data Documentation

◆ BLT_TRIGGER_JOB

final String eu.baltrad.beast.message.mo.BltTriggerJobMessage.BLT_TRIGGER_JOB = "blttriggerjob"
static

The static name of this message.


The documentation for this class was generated from the following file: