Package de.uplanet.lucy.server.workflow.eventhandler

Class TimerJobCompletionWorkflowEventHandler

java.lang.Object

de.uplanet.lucy.server.workflow.eventhandler.AbstractWorkflowEventHandler

de.uplanet.lucy.server.workflow.eventhandler.TimerJobCompletionWorkflowEventHandler

All Implemented Interfaces:

IActivatableWorkflowObject, INamedWorkflowObject, INeedWorkflow, IWorkflowEventHandler, IWorkflowObject, Serializable

public final class TimerJobCompletionWorkflowEventHandler
extends AbstractWorkflowEventHandler

See Also:

• Serialized Form

Field Summary

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

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
TimerJobCompletionWorkflowEventHandler(String p_strGuid)

Method Summary

Modifier and Type	Method	Description
String	getTimerGuid()
boolean	isErrorsOnly()
boolean	isHandlerFor(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx)	Check if this event handler may handle the given event.
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	setErrorsOnly(boolean p_bErrorsOnly)
void	setTimerGuid(String p_strTimerGuid)

Methods inherited from class de.uplanet.lucy.server.workflow.eventhandler.AbstractWorkflowEventHandler

getEfferentTransition, getGuid, getName, getWorkflow, isActive, isHandleExternalEvents, setActive, setEfferentTransition, setHandleExternalEvents, setName, setWorkflow

Methods inherited from class java.lang.Object

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

Constructor Details

TimerJobCompletionWorkflowEventHandler

public TimerJobCompletionWorkflowEventHandler(String p_strGuid)

Method Details

getTimerGuid

public String getTimerGuid()

setTimerGuid

public void setTimerGuid(String p_strTimerGuid)

isErrorsOnly

public boolean isErrorsOnly()

setErrorsOnly

public void setErrorsOnly(boolean p_bErrorsOnly)

isHandlerFor

public boolean isHandlerFor(IWorkflowEvent p_evt,
 de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx)

Description copied from interface: IWorkflowEventHandler

Check if this event handler may handle the given event.

This method should return false if this event handler's state is inactive.

Note: despite this method returns true the event handler is not required to return its efferent transition when process is being called.

Parameters:

p_evt - The event.

p_wfCtx - The workflow processing context.

Returns:

true if this event handler may process this event, or false otherwise.

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: IWorkflowEventHandler

Process a workflow event in the given context.

This method is called by the workflow engine if a call to isHandlerFor returned true. However this method is not required to return a non-null efferent transition in such cases.

A workflow event handler must return null if it is not active.

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.