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

Class StartSchedulerJobWorkflowAction

java.lang.Object

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

de.uplanet.lucy.server.workflow.action.StartSchedulerJobWorkflowAction

All Implemented Interfaces:

IActivatableWorkflowObject, INamedWorkflowObject, INeedWorkflow, IWorkflowAction, IWorkflowObject, Serializable

public final class StartSchedulerJobWorkflowAction
extends AbstractWorkflowAction

See Also:

• Serialized Form

Field Summary

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

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
StartSchedulerJobWorkflowAction(String p_strGuid)

Method Summary

Modifier and Type	Method	Description
String	getContextVariableName()	Get the name of the context variable that contains the GUID of the scheduler job to to be started.
String	getJobGuid()	Get the GUID of the scheduler job to to be started.
String	getJobParameterContextVariableName()	Get the name of the context variable that contains parameters that should be passed to the scheduler job.
boolean	isAllowEmptyJobParameterContextVariable()	If this property is true it is not considered an error condition if a jobParameterContextVariableName is configured and no parameters are provided by this variable at runtime.
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	setAllowEmptyJobParameterContextVariable(boolean p_bAllowEmptyJobParameterContextVariable)	If this property is true it is not considered an error condition if a jobParameterContextVariableName is configured and no parameters are provided by this variable at runtime.
void	setContextVariableName(String p_strContextVariableName)	Set the name of the context variable that contains the GUID of the scheduler job to to be started.
void	setJobGuid(String p_strJobGuid)	Set the GUID of the scheduler job to to be started.
void	setJobParameterContextVariableName(String p_strContextVariableName)	Set the name of the context variable that contains parameters that should be passed to the scheduler job.

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

StartSchedulerJobWorkflowAction

public StartSchedulerJobWorkflowAction(String p_strGuid)

Method Details

getJobGuid

public String getJobGuid()

Get the GUID of the scheduler job to to be started.

Returns:

The GUID of the scheduler job to to be started.

setJobGuid

public void setJobGuid(String p_strJobGuid)

Set the GUID of the scheduler job to to be started.

Parameters:

p_strJobGuid - The GUID of the scheduler job to to be started.

getContextVariableName

public String getContextVariableName()

Get the name of the context variable that contains the GUID of the scheduler job to to be started.

Returns:

The name of the context variable.

See Also:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_WORKFLOW_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

setContextVariableName

public void setContextVariableName(String p_strContextVariableName)

Set the name of the context variable that contains the GUID of the scheduler job to to be started.

Parameters:

p_strContextVariableName - The name of the context variable.

See Also:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_WORKFLOW_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

getJobParameterContextVariableName

public String getJobParameterContextVariableName()

Get the name of the context variable that contains parameters that should be passed to the scheduler job.

The value of the context variable must be a map from strings to objects.

Note that only session or shared state context variables are supported.

By default, it is an error if the configured variable is empty at runtime. This behavior could be changed by setting the property allowEmptyJobParameterContextVariable to true in which case the job will be started without parameters if the variable is empty.

Returns:

The name of the context variable.

See Also:

• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX

setJobParameterContextVariableName

public void setJobParameterContextVariableName(String p_strContextVariableName)

Set the name of the context variable that contains parameters that should be passed to the scheduler job.

The value of the context variable must be a map from strings to objects.

Note that only session or shared state context variables are supported.

By default, it is an error if the configured variable is empty at runtime. This behavior could be changed by setting the property allowEmptyJobParameterContextVariable to true in which case the job will be started without parameters if the variable is empty.

Parameters:

p_strContextVariableName - The name of the context variable.

See Also:

• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX

isAllowEmptyJobParameterContextVariable

public boolean isAllowEmptyJobParameterContextVariable()

If this property is true it is not considered an error condition if a jobParameterContextVariableName is configured and no parameters are provided by this variable at runtime. The job is started without parameters in this case.

Returns:

true or false.

setAllowEmptyJobParameterContextVariable

public void setAllowEmptyJobParameterContextVariable(boolean p_bAllowEmptyJobParameterContextVariable)

If this property is true it is not considered an error condition if a jobParameterContextVariableName is configured and no parameters are provided by this variable at runtime. The job is started without parameters in this case.

Parameters:

p_bAllowEmptyJobParameterContextVariable - The value to be set.

process

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

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:

WorkflowException

de.uplanet.util.InvalidPropertyException