org.pentaho.platform.engine.services.actionsequence
Class ActionDefinition

java.lang.Object
  org.pentaho.platform.engine.services.actionsequence.ActionDefinition

All Implemented Interfaces:

ISolutionActionDefinition

public class ActionDefinition
extends Object
implements ISolutionActionDefinition

Constructor Summary

ActionDefinition(org.dom4j.Node actionRootNode, ILogger logger)

Method Summary

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.
int	getErrorCode()
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.
void	setLoggingLevel(int loggingLevel)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionDefinition

public ActionDefinition(org.dom4j.Node actionRootNode,
                        ILogger logger)

Method Detail

getErrorCode

public int getErrorCode()

getMappedInputName

public String getMappedInputName(String name)

Description copied from interface: ISolutionActionDefinition

Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document

Specified by:

getMappedInputName in interface ISolutionActionDefinition

Parameters:

name - String name of the parameter to get a mapping for

Returns:

String name of the parameter that 'name' is mapped to

getActionInputDefinitions

public Map getActionInputDefinitions()

Description copied from interface: ISolutionActionDefinition

Returns a Map of the input parameters that are defined to this ActionDefinition.

Specified by:

getActionInputDefinitions in interface ISolutionActionDefinition

Returns:

Map of input parameters. Parameters take the name-value form.

getMappedOutputName

public String getMappedOutputName(String name)

Description copied from interface: ISolutionActionDefinition

Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document

Specified by:

getMappedOutputName in interface ISolutionActionDefinition

Parameters:

name - String name of the parameter to get a mapping for

Returns:

String name of the parameter that 'name' is mapped to

getActionOutputDefinitions

public Map getActionOutputDefinitions()

Description copied from interface: ISolutionActionDefinition

Returns a Map of the output parameters that are defined for this ActionDefinition.

Specified by:

getActionOutputDefinitions in interface ISolutionActionDefinition

Returns:

Map of output parameters. Parameters take the name-value form.

getMappedResourceName

public String getMappedResourceName(String name)

Description copied from interface: ISolutionActionDefinition

Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document

Specified by:

getMappedResourceName in interface ISolutionActionDefinition

Parameters:

name - String name of the parameter to get a mapping for

Returns:

String name of the parameter that 'name' is mapped to

getActionResourceDefinitionNames

public List getActionResourceDefinitionNames()

Description copied from interface: ISolutionActionDefinition

Returns a List of the resource parameter names that are defined for this ActionDefinition.

Specified by:

getActionResourceDefinitionNames in interface ISolutionActionDefinition

Returns:

List of resource parameter names.

hasActionResources

public boolean hasActionResources()

Specified by:

hasActionResources in interface ISolutionActionDefinition

setLoggingLevel

public void setLoggingLevel(int loggingLevel)

getComponentName

public String getComponentName()

Description copied from interface: ISolutionActionDefinition

Returns the Java class name of the Component that this ActionDefinition is created for.

Specified by:

getComponentName in interface ISolutionActionDefinition

Returns:

the Java class name of Component for this ActionDefinition

getComponentSection

public org.dom4j.Node getComponentSection()

Description copied from interface: ISolutionActionDefinition

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.

Specified by:

getComponentSection in interface ISolutionActionDefinition

Returns:

the Component definition section of the ActionDefinition

getNode

public org.dom4j.Node getNode()

Specified by:

getNode in interface ISolutionActionDefinition

getSyncPreference

public boolean getSyncPreference()

Description copied from interface: ISolutionActionDefinition

Returns boolean value regarding whether this action is set to execute synchronous or asynchronously.

Specified by:

getSyncPreference in interface ISolutionActionDefinition

Returns:

true, if set to asynchronous, false if set to synchronous

getLoggingLevel

public int getLoggingLevel()

Description copied from interface: ISolutionActionDefinition

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.

Specified by:

getLoggingLevel in interface ISolutionActionDefinition

Returns:

this ActionDefinition's logging level

See Also:

ILogger

getPostExecuteAuditList

public List getPostExecuteAuditList()

Description copied from interface: ISolutionActionDefinition

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.

Specified by:

getPostExecuteAuditList in interface ISolutionActionDefinition

Returns:

List of parameters defined for post-execution auditing

getPreExecuteAuditList

public List getPreExecuteAuditList()

Description copied from interface: ISolutionActionDefinition

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.

Specified by:

getPreExecuteAuditList in interface ISolutionActionDefinition

Returns:

List of parameters defined for pre-execution auditing

getComponent

public IComponent getComponent()

Description copied from interface: ISolutionActionDefinition

Returns the Component object that this ActionDefinition belongs to.

Specified by:

getComponent in interface ISolutionActionDefinition

Returns:

the definition's Component object

setComponent

public void setComponent(IComponent component)

Description copied from interface: ISolutionActionDefinition

Sets the Component object that this definition will belong to. The component must be valid for this ActionDefinition, otherwise execution validation will fail.

Specified by:

setComponent in interface ISolutionActionDefinition

Parameters:

component - the Component that is valid for this definiton.

getIconUrl

public String getIconUrl()

Description copied from interface: ISolutionActionDefinition

Returns the URL to the icon for this definition.

Specified by:

getIconUrl in interface ISolutionActionDefinition

Returns:

the definition's icon URL

getAuthor

public String getAuthor()

Description copied from interface: ISolutionActionDefinition

Returns the author of the ActionDefinition, if defined, or null otherwise.

Specified by:

getAuthor in interface ISolutionActionDefinition

Returns:

this definition's author, or null if not defined.

getDescription

public String getDescription()

Description copied from interface: ISolutionActionDefinition

Returns the description of the ActionDefinition, if defined, or null otherwise.

Specified by:

getDescription in interface ISolutionActionDefinition

Returns:

this definition's description, or null if not defined.

getHelp

public String getHelp()

Description copied from interface: ISolutionActionDefinition

Returns the URL to the Help page for this definition.

Specified by:

getHelp in interface ISolutionActionDefinition

Returns:

the definition's Help URL