com.adobe.aemfd.watchfolder.workflow.api

Interface WorkflowContext

All Superinterfaces:

ProcessorContext

public interface WorkflowContext
extends ProcessorContext

An extension of the ProcessorContext interface which provides workflow-specific functionality to WorkflowContextProcessor implementations.

Method Summary

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.

Methods inherited from interface com.adobe.aemfd.watchfolder.service.api.ProcessorContext

getConfigParameters, getInputMap, getWatchFolderId, setResult

Method Detail

getWorkItem

com.adobe.granite.workflow.exec.WorkItem getWorkItem()

Utility method which returns the current work-item to the 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.

Returns:

The current work-item.

getWorkflowSession

com.adobe.granite.workflow.WorkflowSession getWorkflowSession()

Utility method which returns the current workflow-session to the 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.

Returns:

The current workflow-session.

getMetadata

Map getMetadata()

Utility method which returns the current step's arguments to the 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.

Returns:

The current step's arguments.

getCommittedResults

Map<String,Document> getCommittedResults()

Returns an immutable map representing the outputs generated so far by previous steps in the current workflow instance. Note that within the scope of the current workflow step, this map is not affected when the current step invokes setResult with a file-name which is already present in this map's keys.

Returns:

An immutable map representing the outputs generated so far by previous steps.

getCommittedVariables

Map<String,Object> getCommittedVariables()

Returns an immutable map representing the committed state of the workflow variable values. The committed state of a variable represents the value set by the last workflow step (excluding the current one) which called setVariable for that variable, or the default value specified at design-time if no previous step attempted to modify that variable.

Returns:

An immutable map representing the committed state of the workflow variable values.

setVariable

void setVariable(String varName,
                 Object value)

Sets a value for a workflow variable. Note that the variable must be one of those specified at design-time for the associated watch-folder, and the value must also be of the correct type. For multi-valued variables, the value must be an array of the correct type.
Even though specifying null as the default variable value is currently not allowed at design-time, it is acceptable to pass null as the value to setVariable.

Parameters:

varName - The name of the variable.

value - The variable value of the correct type.