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

Class AbstractWorkflowEventHandler

java.lang.Object

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

All Implemented Interfaces:

IActivatableWorkflowObject, INamedWorkflowObject, INeedWorkflow, IWorkflowEventHandler, IWorkflowObject, Serializable

Direct Known Subclasses:

AbstractEventSourceWorkflowEventHandler, BadMailWorkflowEventHandler, DataGroupWorkflowEventHandler, FileSystemWorkflowEventHandler, GlobalTimerWorkflowEventHandler, GroovyScriptWorkflowEventHandler, IxBrokerWorkflowEventHandler, JMSWorkflowEventHandler, MQTTWorkflowEventHandler, NoopWorkflowEventHandler, SessionLoginWorkflowEventHandler, TimerActionWorkflowEventHandler, TimerJobCompletionWorkflowEventHandler, TimerJobSchedulingWorkflowEventHandler, UserWorkflowEventHandler

public abstract class AbstractWorkflowEventHandler
extends Object
implements IWorkflowEventHandler, INamedWorkflowObject, INeedWorkflow

See Also:

• Serialized Form

Field Summary

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

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
AbstractWorkflowEventHandler(String p_strGuid)

Method Summary

Modifier and Type	Method	Description
WorkflowTransition	getEfferentTransition()	Get the efferent transition of this workflow event handler.
String	getGuid()	Get the GUID of this workflow object.
String	getName()	Get the name of the workflow object.
de.uplanet.lucy.server.workflow.IWorkflow	getWorkflow()	Get the workflow this object belongs to.
boolean	isActive()	Check if this workflow event handler is active or inactive.
boolean	isHandleExternalEvents()	Check if this workflow event handler is configured to handle external events, i.e.
void	setActive(boolean p_bActive)	Set this workflow event handler active or inactive.
void	setEfferentTransition(WorkflowTransition p_wfTransition)	Set the efferent transition of this workflow event handler.
void	setHandleExternalEvents(boolean p_bHandleExternalEvents)	Set the external event handler property.
void	setName(String p_strName)	Set the name of the workflow object.
void	setWorkflow(de.uplanet.lucy.server.workflow.IWorkflow p_wfWorkflow)	Set the workflow this object belongs to.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uplanet.lucy.server.workflow.IWorkflowEventHandler

isHandlerFor, process

Constructor Details

AbstractWorkflowEventHandler

public AbstractWorkflowEventHandler(String p_strGuid)

Method Details

getGuid

public String getGuid()

Description copied from interface: IWorkflowObject

Get the GUID of this workflow object.

Note: implementors must ensure that this is never null.

Specified by:

getGuid in interface IWorkflowObject

Returns:

The GUID of this workflow object

getWorkflow

public de.uplanet.lucy.server.workflow.IWorkflow getWorkflow()

Description copied from interface: INeedWorkflow

Get the workflow this object belongs to.

Specified by:

getWorkflow in interface INeedWorkflow

Returns:

The workflow this object belongs to.

setWorkflow

public void setWorkflow(de.uplanet.lucy.server.workflow.IWorkflow p_wfWorkflow)

Description copied from interface: INeedWorkflow

Set the workflow this object belongs to.

Specified by:

setWorkflow in interface INeedWorkflow

Parameters:

p_wfWorkflow - The workflow this object belongs to.

getEfferentTransition

public WorkflowTransition getEfferentTransition()

Description copied from interface: IWorkflowEventHandler

Get the efferent transition of this workflow event handler.

Specified by:

getEfferentTransition in interface IWorkflowEventHandler

Returns:

The efferent transition, or null.

setEfferentTransition

public void setEfferentTransition(WorkflowTransition p_wfTransition)

Description copied from interface: IWorkflowEventHandler

Set the efferent transition of this workflow event handler.

Specified by:

setEfferentTransition in interface IWorkflowEventHandler

Parameters:

p_wfTransition - The transition to be set.

isActive

public boolean isActive()

Description copied from interface: IWorkflowEventHandler

Check if this workflow event handler is active or inactive.

See IWorkflowEventHandler.process(IWorkflowEvent, IWorkflowProcessingContext, IProcessingContext) for the general contract of the activation state.

Specified by:

isActive in interface IActivatableWorkflowObject

Specified by:

isActive in interface IWorkflowEventHandler

Returns:

The activation state of this workflow event handler.

setActive

public void setActive(boolean p_bActive)

Description copied from interface: IWorkflowEventHandler

Set this workflow event handler active or inactive.

See IWorkflowEventHandler.process(IWorkflowEvent, IWorkflowProcessingContext, IProcessingContext) for the general contract of the activation state.

Specified by:

setActive in interface IActivatableWorkflowObject

Specified by:

setActive in interface IWorkflowEventHandler

Parameters:

p_bActive - The new activation state to be set.

getName

public String getName()

Description copied from interface: INamedWorkflowObject

Get the name of the workflow object.

Specified by:

getName in interface INamedWorkflowObject

Returns:

The name of the workflow object.

setName

public void setName(String p_strName)

Description copied from interface: INamedWorkflowObject

Set the name of the workflow object.

Specified by:

setName in interface INamedWorkflowObject

Parameters:

p_strName - The name of the workflow object.

isHandleExternalEvents

public boolean isHandleExternalEvents()

Description copied from interface: IWorkflowEventHandler

Check if this workflow event handler is configured to handle external events, i.e. events that are not created by other workflows, or the workflow engine itself.

The default value of this property is true.

Specified by:

isHandleExternalEvents in interface IWorkflowEventHandler

Returns:

true if this event handler handles external events, or false otherwise.

setHandleExternalEvents

public void setHandleExternalEvents(boolean p_bHandleExternalEvents)

Description copied from interface: IWorkflowEventHandler

Set the external event handler property.

Specified by:

setHandleExternalEvents in interface IWorkflowEventHandler

Parameters:

p_bHandleExternalEvents - The new value.

See Also:

• IWorkflowEventHandler.isHandleExternalEvents()