Package org.imixs.workflow.engine.plugins

Klasse IntervalPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.IntervalPlugin

Alle implementierten Schnittstellen:

Plugin

public class IntervalPlugin
extends AbstractPlugin

The Imixs Interval Plugin implements an mechanism to adjust a date field of a workitem based on a interval description. The interval description is stored in a field with the prafix 'keyinterval' followed by the name of an existing date field. See the following example:

 
<item name="interval">
    <ref>reminder</ref>
    <cron>5 15 * * 1-5</cron>
</item>
 

Version:

1.0

Autor:

Ralph Soika

Siehe auch:

• Ungültige Referenz

  org.imixs.workflow.WorkflowManager

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	EVAL_INTERVAL
boolean	increase
static final String	INVALID_FORMAT

Von Klasse geerbte Felder org.imixs.workflow.engine.plugins.AbstractPlugin

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
IntervalPlugin()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
LocalDateTime	evalCron(String cron)
LocalDateTime	evalCron(String cron, LocalDateTime baseDateTime)	evaluates a cron definition
LocalDateTime	evalMacro(String macro, LocalDateTime ldt)	The method evaluates a macro.
ItemCollection	run(ItemCollection adocumentContext, ItemCollection event)	The method paresed for a fields with the prafix 'keyitnerval'

Von Klasse geerbte Methoden org.imixs.workflow.engine.plugins.AbstractPlugin

close, getWorkflowContext, getWorkflowService, init, mergeFieldList, setWorkflowService, uniqueList

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

EVAL_INTERVAL

public static final String EVAL_INTERVAL

Siehe auch:

• Konstantenfeldwerte

INVALID_FORMAT

public static final String INVALID_FORMAT

Siehe auch:

• Konstantenfeldwerte

increase

public boolean increase

Konstruktordetails

IntervalPlugin

public IntervalPlugin()

Methodendetails

run

public ItemCollection run(ItemCollection adocumentContext,
 ItemCollection event)
                   throws PluginException

The method paresed for a fields with the prafix 'keyitnerval'

Parameter:

adocumentContext - the workitem to be processed

event - the workflow event containing the processing instructions

Gibt zurück:

updated workitem for further processing

Löst aus:

PluginException

evalCron

public LocalDateTime evalCron(String cron,
 LocalDateTime baseDateTime)
                       throws PluginException

evaluates a cron definition

Parameter:

cron - - a cron definition * * * * *

baseDateTime - - the base dateTime for the evaluation

Gibt zurück:

next dateTime

Löst aus:

PluginException

evalCron

public LocalDateTime evalCron(String cron)
                       throws PluginException

Löst aus:

PluginException

evalMacro

public LocalDateTime evalMacro(String macro,
 LocalDateTime ldt)
                        throws PluginException

The method evaluates a macro. Possible values:

• @yearly
• @monthly
• @weekly
• @daily
• @hourly

Parameter:

macro -

date -

Gibt zurück:

Löst aus:

PluginException