Package de.uplanet.lucy.server.workflow.action

Class TimerWorkflowAction

java.lang.Object

de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

de.uplanet.lucy.server.workflow.action.AbstractTimerWorkflowAction

de.uplanet.lucy.server.workflow.action.TimerWorkflowAction

All Implemented Interfaces:

IActivatableWorkflowObject, INamedWorkflowObject, INeedWorkflow, IWorkflowAction, IWorkflowObject, Serializable

public final class TimerWorkflowAction
extends AbstractTimerWorkflowAction

See Also:

• Serialized Form

Field Summary

Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
TimerWorkflowAction(String p_strGuid)

Method Summary

Modifier and Type	Method	Description
List<String>	getRules()	Get the rules for this timer.
boolean	isAbsolute()	Check if this timer action creates an absolute timer.
WorkflowTransition	process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx)	Process a workflow event in the given context.
void	setAbsolute(boolean p_bAbsolute)	Set whether or not this timer action should create an absolute timer.
void	setRules(List<String> p_rules)	Set the rules for this timer.

Methods inherited from class de.uplanet.lucy.server.workflow.action.AbstractTimerWorkflowAction

getRulesTimeZone, getSavedState, isTriggerOverdueTimer, setRulesTimeZone, setSavedState, setTriggerOverdueTimer

Methods inherited from class de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

getAfferentTransition, getEfferentTransition, getGuid, getName, getWorkflow, isActive, setActive, setAfferentTransition, setEfferentTransition, setName, setWorkflow, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TimerWorkflowAction

public TimerWorkflowAction(String p_strGuid)

Method Details

isAbsolute

public boolean isAbsolute()

Check if this timer action creates an absolute timer.

Returns:

true if this timer action creates an absolute timer, or false otherwise.

setAbsolute

public void setAbsolute(boolean p_bAbsolute)

Set whether or not this timer action should create an absolute timer.

Parameters:

p_bAbsolute - true if this timer action should create an absolute timer, or false otherwise.

getRules

public List<String> getRules()

Get the rules for this timer.

Note: To make Spring happy, this method returns a reference to the internal list that holds the rules. This breaks proper encapsulation, so beware of modifying the returned list.

Returns:

The rules for this timer.

setRules

public void setRules(List<String> p_rules)

Set the rules for this timer.

Parameters:

p_rules - The rules for this timer.

process

public WorkflowTransition process(IWorkflowEvent p_evt,
 de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx,
 de.uplanet.lucy.server.IProcessingContext p_ctx)
                           throws Exception

Description copied from interface: IWorkflowAction

Process a workflow event in the given context.

Normally, a workflow action should return its efferent transition, regardless whether it is active, or not.

Parameters:

p_evt - The event to be processed.

p_wfCtx - The workflow processing context.

p_ctx - The processing context.

Returns:

The efferent transition, or null.

Throws:

Exception - If an error occurred.