public interface WorkflowContext extends ProcessorContext
ProcessorContext
interface which provides workflow-specific
functionality to WorkflowContextProcessor
implementations.Modifier and Type | Method and Description |
---|---|
Map<String,Document> |
getCommittedResults()
Returns an immutable map representing the outputs generated so far by previous steps in the current
workflow instance.
|
Map<String,Object> |
getCommittedVariables()
Returns an immutable map representing the committed state of the workflow variable values.
|
Map |
getMetadata()
Utility method which returns the current step's arguments to the
WorkflowContextProcessor
implementation. |
com.adobe.granite.workflow.WorkflowSession |
getWorkflowSession()
Utility method which returns the current workflow-session to the
WorkflowContextProcessor
implementation. |
com.adobe.granite.workflow.exec.WorkItem |
getWorkItem()
Utility method which returns the current work-item to the
WorkflowContextProcessor
implementation. |
void |
setVariable(String varName,
Object value)
Sets a value for a workflow variable.
|
getConfigParameters, getInputMap, getWatchFolderId, setResult
com.adobe.granite.workflow.exec.WorkItem getWorkItem()
WorkflowContextProcessor
implementation. This is the same work-item which was passed to the execute
method
of WorkflowContextService
by the current workflow step, which in turn was passed
to the workflow step by the workflow engine.com.adobe.granite.workflow.WorkflowSession getWorkflowSession()
WorkflowContextProcessor
implementation. This is the same workflow-session which was passed to the execute
method
of WorkflowContextService
by the current workflow step, which in turn was passed
to the workflow step by the workflow engine.Map getMetadata()
WorkflowContextProcessor
implementation. These are the same arguments which were passed to the execute
method
of WorkflowContextService
by the current workflow step, which in turn were passed
to the workflow step by the workflow engine.Map<String,Document> getCommittedResults()
setResult
with a file-name which is already present in this map's
keys.Map<String,Object> getCommittedVariables()
setVariable
for that variable, or the default value specified at design-time if no previous
step attempted to modify that variable.void setVariable(String varName, Object value)
null
as the default variable value is currently not allowed at design-time,
it is acceptable to pass null
as the value to setVariable
.varName
- The name of the variable.value
- The variable value of the correct type.Copyright © 1982–2022 Adobe Systems Inc.. All rights reserved.