ISolutionActionDefinition (pentaho-platform-api 9.0.0.1-426 API)

```
public interface ISolutionActionDefinition
```
The ActionDefinition represents the definition and metadata for a single action execution, which is equivalent to one execution of any given Component.
The ActionDefinition is derived from the solution's action sequence document. One ActionDefinition is handed to the appropriate Component, and provides all the necessary inputs, outputs and resources for that Component to execute.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Map`	`getActionInputDefinitions()` Returns a Map of the input parameters that are defined to this ActionDefinition.
`Map`	`getActionOutputDefinitions()` Returns a `Map` of the output parameters that are defined for this ActionDefinition.
`List`	`getActionResourceDefinitionNames()` Returns a `List` of the resource parameter names that are defined for this ActionDefinition.
`String`	`getAuthor()` Returns the author of the ActionDefinition, if defined, or null otherwise.
`IComponent`	`getComponent()` Returns the Component object that this ActionDefinition belongs to.
`String`	`getComponentName()` Returns the Java class name of the Component that this ActionDefinition is created for.
`org.dom4j.Node`	`getComponentSection()` Returns the Component definition portion of this ActionDefinition.
`String`	`getDescription()` Returns the description of the ActionDefinition, if defined, or null otherwise.
`String`	`getHelp()` Returns the URL to the Help page for this definition.
`String`	`getIconUrl()` Returns the URL to the icon for this definition.
`int`	`getLoggingLevel()` Get the logging level for this ActionDefinition.
`String`	`getMappedInputName(String name)` Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
`String`	`getMappedOutputName(String name)` Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
`String`	`getMappedResourceName(String name)` Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
`org.dom4j.Node`	`getNode()`
`List`	`getPostExecuteAuditList()` Returns the list of input and output parameters that will be audited after component execution.
`List`	`getPreExecuteAuditList()` Returns the list of input and output parameters that will be audited before component execution.
`boolean`	`getSyncPreference()` Returns boolean value regarding whether this action is set to execute synchronous or asynchronously.
`boolean`	`hasActionResources()`
`void`	`setComponent(IComponent component)` Sets the Component object that this definition will belong to.

- Method Detail
  - getActionInputDefinitions
```
Map getActionInputDefinitions()
```
    Returns a Map of the input parameters that are defined to this ActionDefinition.
    
    Returns:
    
    Map of input parameters. Parameters take the name-value form.
  - getMappedInputName
```
String getMappedInputName(String name)
```
    Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
    
    Parameters:
    
    name - String name of the parameter to get a mapping for
    
    Returns:
    
    String name of the parameter that 'name' is mapped to
  - getActionOutputDefinitions
```
Map getActionOutputDefinitions()
```
    Returns a Map of the output parameters that are defined for this ActionDefinition.
    
    Returns:
    
    Map of output parameters. Parameters take the name-value form.
  - getMappedOutputName
```
String getMappedOutputName(String name)
```
    Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
    
    Parameters:
    
    name - String name of the parameter to get a mapping for
    
    Returns:
    
    String name of the parameter that 'name' is mapped to
  - getActionResourceDefinitionNames
```
List getActionResourceDefinitionNames()
```
    Returns a List of the resource parameter names that are defined for this ActionDefinition.
    
    Returns:
    
    List of resource parameter names.
  - hasActionResources
```
boolean hasActionResources()
```
  - getMappedResourceName
```
String getMappedResourceName(String name)
```
    Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
    
    Parameters:
    
    name - String name of the parameter to get a mapping for
    
    Returns:
    
    String name of the parameter that 'name' is mapped to
  - getLoggingLevel
```
int getLoggingLevel()
```
    Get the logging level for this ActionDefinition. The logging level may be set independently or may be inherited from a parent object's logging level.
    
    Returns:
    
    this ActionDefinition's logging level
    
    See Also:
    
    ILogger
  - getPreExecuteAuditList
```
List getPreExecuteAuditList()
```
    Returns the list of input and output parameters that will be audited before component execution. This list is handed off to the auditing subsystem as metadata.
    
    Returns:
    
    List of parameters defined for pre-execution auditing
  - getPostExecuteAuditList
```
List getPostExecuteAuditList()
```
    Returns the list of input and output parameters that will be audited after component execution. This list is handed off to the auditing subsystem as metadata.
    
    Returns:
    
    List of parameters defined for post-execution auditing
  - getSyncPreference
```
boolean getSyncPreference()
```
    Returns boolean value regarding whether this action is set to execute synchronous or asynchronously.
    
    Returns:
    
    true, if set to asynchronous, false if set to synchronous
  - getComponentName
```
String getComponentName()
```
    Returns the Java class name of the Component that this ActionDefinition is created for.
    
    Returns:
    
    the Java class name of Component for this ActionDefinition
  - getComponentSection
```
org.dom4j.Node getComponentSection()
```
    Returns the Component definition portion of this ActionDefinition. The Component section typically describes that data and metadata that is relevant only to that particular component.
    
    Returns:
    
    the Component definition section of the ActionDefinition
  - getNode
```
org.dom4j.Node getNode()
```
  - getComponent
```
IComponent getComponent()
```
    Returns the Component object that this ActionDefinition belongs to.
    
    Returns:
    
    the definition's Component object
  - getAuthor
```
String getAuthor()
```
    Returns the author of the ActionDefinition, if defined, or null otherwise.
    
    Returns:
    
    this definition's author, or null if not defined.
  - getDescription
```
String getDescription()
```
    Returns the description of the ActionDefinition, if defined, or null otherwise.
    
    Returns:
    
    this definition's description, or null if not defined.
  - getHelp
```
String getHelp()
```
    Returns the URL to the Help page for this definition.
    
    Returns:
    
    the definition's Help URL
  - getIconUrl
```
String getIconUrl()
```
    Returns the URL to the icon for this definition.
    
    Returns:
    
    the definition's icon URL
  - setComponent
```
void setComponent(IComponent component)
```
    Sets the Component object that this definition will belong to. The component must be valid for this ActionDefinition, otherwise execution validation will fail.
    
    Parameters:
    
    component - the Component that is valid for this definiton.

Interface ISolutionActionDefinition

Method Summary

Method Detail

getActionInputDefinitions

getMappedInputName

getActionOutputDefinitions

getMappedOutputName

getActionResourceDefinitionNames

hasActionResources

getMappedResourceName

getLoggingLevel

getPreExecuteAuditList

getPostExecuteAuditList

getSyncPreference

getComponentName

getComponentSection

getNode

getComponent

getAuthor

getDescription

getHelp

getIconUrl

setComponent