AbstractNodeWorkflowComponent (Ametys 4.5.x - API)

java.lang.Object
- org.ametys.plugins.workflow.AbstractWorkflowComponent
- - org.ametys.plugins.workspaces.workflow.AbstractNodeWorkflowComponent

All Implemented Interfaces:

LogEnabled, Serviceable

Direct Known Subclasses:

AddEventFunction, SendCalendarNotificationFunction
```
public abstract class AbstractNodeWorkflowComponent
extends AbstractWorkflowComponent
```
Abstract class for easily retrieving environment components in a condition or a function and especially a resource.

Field Summary

Fields
Modifier and Type Field Description

static String EXPLORERNODE_KEY
Constant for storing the content into the transient variables map.
- Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent
  _logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors
Constructor Description

AbstractNodeWorkflowComponent()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected ExplorerNode`	`getExplorerNode(Map transientVars)`	Retrieve the resource associated with the workflow.

Methods inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent
addWorkflowError, addWorkflowWarning, enableLogging, getConditionFailures, getContextParameters, getResultsMap, getUser, service

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXPLORERNODE_KEY
```
public static final String EXPLORERNODE_KEY
```
    Constant for storing the content into the transient variables map.
- Constructor Detail
  - AbstractNodeWorkflowComponent
```
public AbstractNodeWorkflowComponent()
```
- Method Detail
  - getExplorerNode
```
protected ExplorerNode getExplorerNode(Map transientVars)
                                throws com.opensymphony.workflow.WorkflowException
```
    Retrieve the resource associated with the workflow.
    
    Parameters:
    
    transientVars - the parameters from the call.
    
    Returns:
    
    the resource.
    
    Throws:
    
    com.opensymphony.workflow.WorkflowException - if the resource is not found.