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

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

All Implemented Interfaces:

ISequenceDefinition

public class SequenceDefinition
extends java.lang.Object
implements ISequenceDefinition

Field Summary

Fields inherited from interface org.pentaho.platform.api.engine.ISequenceDefinition

ACTION_SEQUENCE_DEFINITION_INVALID_ACTION_DOC, ACTION_SEQUENCE_DEFINITION_INVALID_XML, ACTION_SEQUENCE_DEFINITION_OK, RESULT_TYPE_NONE, RESULT_TYPE_PROCESS, RESULT_TYPE_REPORT, RESULT_TYPE_RULE

Method Summary

static IActionSequence	ActionSequenceFactory(org.dom4j.Document document, java.lang.String actionName, java.lang.String solutionPath, java.lang.String solutionName, ILogger logger, IApplicationContext applicationContext, int loggingLevel)
java.lang.String	getAuthor() Returns the author of the SequenceDefinition, if defined, or null otherwise.
java.lang.String	getCacheLevel()
java.lang.String	getDescription() Returns the description of this SequenceDefinition, if defined, or null otherwise.
int	getErrorCode()
java.lang.String	getHelp() Returns the URL to the Help page for this definition.
java.lang.String	getIcon() Returns the path to the icon for this SequenceDefinition.
java.util.Map	getInputDefinitions() Returns a Map of the input parameters that are defined to this SequenceDefinition.
java.util.Map	getInputDefinitionsForParameterProvider(java.lang.String parameterProviderName) Returns a Map of the input parameters that are defined to this SequenceDefinition for a specific parameter provider.
int	getLoggingLevel() Get the logging level for this SequenceDefinition.
java.util.Map	getOutputDefinitions() Returns a Map of the output parameters that are defined to this SequenceDefinition.
java.util.Map	getResourceDefinitions() Returns the sequence's resource definitions as a Map.
java.lang.String	getResultType() Returns the type of the overall result of executing the action sequence document that this SequenceDefinition came from.
java.lang.String	getSequenceName() Returns the document name of the action sequence document that this SequenceDefinition came from.
java.lang.String	getSolutionName() Returns the solution name, which is the name at the root level of the solution path.
java.lang.String	getSolutionPath() Returns the path relative to the solution name that will lead to this definition
java.lang.String	getTitle() Returns the title of this SequenceDefinition, if defined, or null otherwise.
java.lang.String	getVersion()
boolean	isWebService()

Methods inherited from class java.lang.Object

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

Method Detail

ActionSequenceFactory

public static IActionSequence ActionSequenceFactory(org.dom4j.Document document,
                                                    java.lang.String actionName,
                                                    java.lang.String solutionPath,
                                                    java.lang.String solutionName,
                                                    ILogger logger,
                                                    IApplicationContext applicationContext,
                                                    int loggingLevel)

getVersion

public java.lang.String getVersion()

isWebService

public boolean isWebService()

getCacheLevel

public java.lang.String getCacheLevel()

getErrorCode

public int getErrorCode()

getInputDefinitions

public java.util.Map getInputDefinitions()

Description copied from interface: ISequenceDefinition

Returns a Map of the input parameters that are defined to this SequenceDefinition. These inputs are part of the contract between this sequence definition and the platform subsystems, ie., the runtime context.

Specified by:

getInputDefinitions in interface ISequenceDefinition

Returns:

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

getInputDefinitionsForParameterProvider

public java.util.Map getInputDefinitionsForParameterProvider(java.lang.String parameterProviderName)

Description copied from interface: ISequenceDefinition

Returns a Map of the input parameters that are defined to this SequenceDefinition for a specific parameter provider. For example the input named "REGION" may come from a request parameter named "regn" Calling this method passing in "request" for the parameterproviderName will return a map that includes an entry with the key "regn" mapped to the "REGION" IActionParameter.

Specified by:

getInputDefinitionsForParameterProvider in interface ISequenceDefinition

Parameters:

parameterProviderName - The name of the parameter provider e.g. "request", "session", "global"...

Returns:

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

getOutputDefinitions

public java.util.Map getOutputDefinitions()

Description copied from interface: ISequenceDefinition

Returns a Map of the output parameters that are defined to this SequenceDefinition. These outputs are part of the contract between this sequence definition and the platform subsystems, ie., the runtime context.

Specified by:

getOutputDefinitions in interface ISequenceDefinition

Returns:

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

getResourceDefinitions

public java.util.Map getResourceDefinitions()

Description copied from interface: ISequenceDefinition

Returns the sequence's resource definitions as a Map. Resources are elements that exist outside of the action sequence document, such as images, icons, additional definition documents, etc.

Specified by:

getResourceDefinitions in interface ISequenceDefinition

Returns:

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

getSequenceName

public java.lang.String getSequenceName()

Description copied from interface: ISequenceDefinition

Returns the document name of the action sequence document that this SequenceDefinition came from.

Specified by:

getSequenceName in interface ISequenceDefinition

Returns:

the action sequence document name

getAuthor

public java.lang.String getAuthor()

Description copied from interface: ISequenceDefinition

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

Specified by:

getAuthor in interface ISequenceDefinition

Returns:

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

getDescription

public java.lang.String getDescription()

Description copied from interface: ISequenceDefinition

Returns the description of this SequenceDefinition, if defined, or null otherwise.

Specified by:

getDescription in interface ISequenceDefinition

Returns:

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

getResultType

public java.lang.String getResultType()

Description copied from interface: ISequenceDefinition

Returns the type of the overall result of executing the action sequence document that this SequenceDefinition came from. For example if the sequence results in the generation of a report the result type for the sequence should be RESULT_TYPE_REPORT. This property is used to select icons to show next to the sequence name when users navigate the available actions. Tif this returns RESULT_TYPE_NONE, empty string or null, the action sequence will not be visible to users as they navigate

Specified by:

getResultType in interface ISequenceDefinition

Returns:

the action sequence result type

getHelp

public java.lang.String getHelp()

Description copied from interface: ISequenceDefinition

Returns the URL to the Help page for this definition.

Specified by:

getHelp in interface ISequenceDefinition

Returns:

the definition's Help URL

getTitle

public java.lang.String getTitle()

Description copied from interface: ISequenceDefinition

Returns the title of this SequenceDefinition, if defined, or null otherwise.

Specified by:

getTitle in interface ISequenceDefinition

Returns:

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

getSolutionName

public java.lang.String getSolutionName()

Description copied from interface: ISequenceDefinition

Returns the solution name, which is the name at the root level of the solution path.

Specified by:

getSolutionName in interface ISequenceDefinition

Returns:

the name of the root level of this definition's solution

getSolutionPath

public java.lang.String getSolutionPath()

Description copied from interface: ISequenceDefinition

Returns the path relative to the solution name that will lead to this definition

Specified by:

getSolutionPath in interface ISequenceDefinition

Returns:

the solution path to this definition

getLoggingLevel

public int getLoggingLevel()

Description copied from interface: ISequenceDefinition

Get the logging level for this SequenceDefinition. The logging level may be set independently or may be inherited from a parent object's logging level.

Specified by:

getLoggingLevel in interface ISequenceDefinition

Returns:

this SequenceDefinition's logging level

See Also:

ILogger

getIcon

public java.lang.String getIcon()

Description copied from interface: ISequenceDefinition

Returns the path to the icon for this SequenceDefinition. The path can be relative or absolute In the pre-configured install these paths are URLs of the form /style/icons/iconname.png This path is used by the navigation XSL to generate the navigation user interface. If this property is not set a generic icon is used.

Specified by:

getIcon in interface ISequenceDefinition

Returns:

the url to the icon