Package org.pentaho.platform.api.engine

Interface ISequenceDefinition

  • All Known Subinterfaces:
    IActionSequence
    public interface ISequenceDefinition
    The SequenceDefinition represents the definition of several consecutive action definitions that comprise an ActionSequence object, which is the runtime equivalent of an action sequence document.

    A SequenceDefinition can contain one to many ActionDefinitions that, when executed by their constituent Components, flow automatically from one ActionDefinition to the next.

    • Field Detail

      • ACTION_SEQUENCE_DEFINITION_OK

        static final int ACTION_SEQUENCE_DEFINITION_OK
        return code indicating a valid SequenceDefinition
        See Also:
        Constant Field Values

      • ACTION_SEQUENCE_DEFINITION_INVALID_XML

        static final int ACTION_SEQUENCE_DEFINITION_INVALID_XML
        return code indicating a problem with the action sequences's XML
        See Also:
        Constant Field Values

      • ACTION_SEQUENCE_DEFINITION_INVALID_ACTION_DOC

        static final int ACTION_SEQUENCE_DEFINITION_INVALID_ACTION_DOC
        return code indicating an action document that does validate against the action document schema
        See Also:
        Constant Field Values

      • RESULT_TYPE_NONE

        static final String RESULT_TYPE_NONE
        result-type value indicating the action should be not be displayed to users during navigation
        See Also:
        Constant Field Values

      • RESULT_TYPE_REPORT

        static final String RESULT_TYPE_REPORT
        result-type value indicating the action should be be displayed as a report to users during navigation
        See Also:
        Constant Field Values

      • RESULT_TYPE_RULE

        static final String RESULT_TYPE_RULE
        result-type value indicating the action should be be displayed as a business rule to users during navigation
        See Also:
        Constant Field Values

      • RESULT_TYPE_PROCESS

        static final String RESULT_TYPE_PROCESS
        result-type value indicating the action should be be displayed as a process to users during navigation
        See Also:
        Constant Field Values

    • Method Detail

      • getInputDefinitions

        Map getInputDefinitions()
        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.
        Returns:
        Map of input parameters. Parameters take the name-value form.

      • getInputDefinitionsForParameterProvider

        Map getInputDefinitionsForParameterProvider​(String parameterProviderName)
        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.
        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

        Map getOutputDefinitions()
        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.
        Returns:
        Map of output parameters. Parameters take the name-value form.

      • getResourceDefinitions

        Map getResourceDefinitions()
        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.
        Returns:
        Map of resource parameters. Parameters take the name-value form.

      • getSequenceName

        String getSequenceName()
        Returns the document name of the action sequence document that this SequenceDefinition came from.
        Returns:
        the action sequence document name

      • getResultType

        String getResultType()
        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
        Returns:
        the action sequence result type

      • getAuthor

        String getAuthor()
        Returns the author of the SequenceDefinition, if defined, or null otherwise.
        Returns:
        this definition's author, or null if not defined.

      • getDescription

        String getDescription()
        Returns the description of this SequenceDefinition, 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

      • getTitle

        String getTitle()
        Returns the title of this SequenceDefinition, if defined, or null otherwise.
        Returns:
        this definition's title, or null if not defined.

      • getSolutionName

        String getSolutionName()
        Returns the solution name, which is the name at the root level of the solution path.
        Returns:
        the name of the root level of this definition's solution

      • getSolutionPath

        String getSolutionPath()
        Returns the path relative to the solution name that will lead to this definition
        Returns:
        the solution path to this definition

      • getLoggingLevel

        int getLoggingLevel()
        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.
        Returns:
        this SequenceDefinition's logging level
        See Also:
        ILogger

      • getIcon

        String getIcon()
        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.
        Returns:
        the url to the icon