Class StartSchedulerJobWorkflowAction
- All Implemented Interfaces:
IActivatableWorkflowObject
,INamedWorkflowObject
,INeedWorkflow
,IWorkflowAction
,IWorkflowObject
,Serializable
- See Also:
-
Field Summary
Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject
GUID_COMPARATOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the name of the context variable that contains the GUID of the scheduler job to to be started.Get the GUID of the scheduler job to to be started.Get the name of the context variable that contains parameters that should be passed to the scheduler job.boolean
If this property istrue
it is not considered an error condition if ajobParameterContextVariableName
is configured and no parameters are provided by this variable at runtime.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 istrue
it is not considered an error condition if ajobParameterContextVariableName
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
-
Constructor Details
-
StartSchedulerJobWorkflowAction
-
-
Method Details
-
getJobGuid
Get the GUID of the scheduler job to to be started.- Returns:
- The GUID of the scheduler job to to be started.
-
setJobGuid
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
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:
-
setContextVariableName
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:
-
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
totrue
in which case the job will be started without parameters if the variable is empty.- Returns:
- The name of the context variable.
- See Also:
-
setJobParameterContextVariableName
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
totrue
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:
-
isAllowEmptyJobParameterContextVariable
public boolean isAllowEmptyJobParameterContextVariable()If this property istrue
it is not considered an error condition if ajobParameterContextVariableName
is configured and no parameters are provided by this variable at runtime. The job is started without parameters in this case.- Returns:
true
orfalse
.
-
setAllowEmptyJobParameterContextVariable
public void setAllowEmptyJobParameterContextVariable(boolean p_bAllowEmptyJobParameterContextVariable) If this property istrue
it is not considered an error condition if ajobParameterContextVariableName
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
-