Package de.uplanet.lucy.server.workflow.condition

Class ApplicationApiRequestWorkflowCondition

java.lang.Object

de.uplanet.lucy.server.workflow.condition.AbstractWorkflowCondition

de.uplanet.lucy.server.workflow.condition.ApplicationApiRequestWorkflowCondition

All Implemented Interfaces:

IActivatableWorkflowObject, INamedWorkflowObject, INeedWorkflow, IWorkflowCondition, IWorkflowObject, Serializable

public final class ApplicationApiRequestWorkflowCondition
extends AbstractWorkflowCondition

This condition can be used to distinguish processing contexts that are associated with an Application API request from other processing contexts.

It can have on, or two, or three efferent transitions, one of which is taken in case of an Application API request, while the other is taken when there is no such request. The third transition, if defined, is always taken.

See Also:

• Serialized Form

Field Summary

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

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
ApplicationApiRequestWorkflowCondition(String p_strGuid)

Method Summary

Modifier and Type	Method	Description
String	getTransitionAlways()	Get the name of the transition that is always taken.
String	getTransitionFalse()	Get the name of the transition that is taken when the current processing context is not associated with an Application API request.
String	getTransitionTrue()	Get the name of the transition that is taken when the current processing context is associated with an Application API request.
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	setTransitionAlways(String p_strTransitionAlways)	Set the name of the transition that is always taken.
void	setTransitionFalse(String p_strTransitionFalse)	Set the name of the transition that is taken when the current processing context is not associated with an Application API request.
void	setTransitionTrue(String p_strTransitionTrue)	Set the name of the transition that is taken when the current processing context is associated with an Application API request.

Methods inherited from class de.uplanet.lucy.server.workflow.condition.AbstractWorkflowCondition

getAfferentTransition, getEfferentTransitions, getGuid, getName, getWorkflow, isActive, setActive, setAfferentTransition, setEfferentTransitions, setName, setWorkflow, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationApiRequestWorkflowCondition

public ApplicationApiRequestWorkflowCondition(String p_strGuid)

Method Details

getTransitionTrue

public String getTransitionTrue()

Get the name of the transition that is taken when the current processing context is associated with an Application API request.

The default value is "true".

Returns:

The name of the transition.

setTransitionTrue

public void setTransitionTrue(String p_strTransitionTrue)

Set the name of the transition that is taken when the current processing context is associated with an Application API request.

The default value is "true".

Parameters:

p_strTransitionTrue - The name of the transition.

getTransitionFalse

public String getTransitionFalse()

Get the name of the transition that is taken when the current processing context is not associated with an Application API request.

The default value is "false".

Returns:

The name of the transition.

setTransitionFalse

public void setTransitionFalse(String p_strTransitionFalse)

Set the name of the transition that is taken when the current processing context is not associated with an Application API request.

The default value is "false".

Parameters:

p_strTransitionFalse - The name of the transition.

getTransitionAlways

public String getTransitionAlways()

Get the name of the transition that is always taken.

The default value is "always".

Returns:

The name of the transition.

setTransitionAlways

public void setTransitionAlways(String p_strTransitionAlways)

Set the name of the transition that is always taken.

The default value is "always".

Parameters:

p_strTransitionAlways - The name of the transition.

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

Process a workflow event in the given context.

The workflow engine will follow the resulting transitions in the order they were returned in the array.

Normally, a workflow condition should return null or an empty array 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 transitions, or an empty array, or null.

Throws:

InterruptedException - If processing of this condition has been interrupted.

Exception - If an error occurred.