Package org.pentaho.platform.api.engine

Interface IActionParameter

  • public interface IActionParameter
    An IActionParameter represents one input or output in an IActionSequence. The IActionParameter is made up of a name or key, and a value.

    • Method Detail

      • getName

        String getName()
        Get the name, or the key for this ActionParameter.
        Returns:
        the ActionParameter name

      • getStringValue

        String getStringValue()
        Get the value for this ActionParameter as type String.
        Returns:
        the ActionParameter value as a String. getType() should be referenced first to be sure the value type is TYPE_STRING.

      • getValue

        Object getValue()
        Get the value for this ActionParameter as a generic Java Object.
        Returns:
        the ActionParameter value as an Object

      • getValueAsList

        List getValueAsList()
        Get the value for this ActionParameter as a java.util.List.
        Returns:
        the ActionParameter value as a List. getType() should be referenced first to be sure the value type is TYPE_LIST.

      • getValueAsResultSet

        org.pentaho.commons.connection.IPentahoResultSet getValueAsResultSet()
        Get the value for this ActionParameter as a IPentahoResultSet
        Returns:
        the IPentahoResultSet getType() should be referenced first to be sure the value type is TYPE_RESULT_SET.

      • getType

        String getType()
        Return the value type as one of the constants available in this class.
        Returns:
        valid return values are TYPE_STRING, TYPE_INTEGER, TYPE_LIST, TYPE_CONTENT or TYPE_DATE

      • setValue

        void setValue​(Object value)
        Sets the value object for this ActionParameter.
        Parameters:
        value - the value Object to be set.

      • getVariables

        List getVariables()
        Returns:
        List of where the parameter may come from (request, session, etc)

      • hasDefaultValue

        boolean hasDefaultValue()
        Check if this ActionParameter has a default value set.
        Returns:
        true if there is a default value, otherwise false

      • hasValue

        boolean hasValue()
        Check to se if a value has been set for this parameter. Default value does not count;
        Returns:
        true if this parameter has a non default value

      • isDefaultValue

        boolean isDefaultValue()
        Check to see if the value returned from thisActionParameter is indeed the default value instead of a value that was set.
        Returns:
        true if the parameter is using the default value, false otherwise

      • isNull

        boolean isNull()
        Check to see if the value (includes the default value) is null.
        Returns:
        true if the value is null, otherwise false

      • dispose

        void dispose()
        See if we need to do any cleanup here

      • setPromptStatus

        boolean setPromptStatus​(int status)
        Sets the prompt status for this parameter.
        Parameters:
        status - The status to set.
        Returns:
        true if the set was successful or false if the current setting cannot be changed.
        See Also:
        PROMPT_ALLOWED, PROMPT_NEVER, PROMPT_NEEDED, PROMPT_PENDING

      • hasSelections

        boolean hasSelections()

      • getSelectionDisplayName

        String getSelectionDisplayName()
        The display name to use when building a prompt.
        Returns:
        The display name for the prompt.

      • getSelectionNameForValue

        String getSelectionNameForValue​(String value)
        When building a parameter prompt page, what is the name of the prompt
        Parameters:
        value -
        Returns:
        name for the value

      • isOutputParameter

        boolean isOutputParameter()
        Returns:
        Whether parameter should be displayed in output.

      • getSelectionNameMap

        @Deprecated
Map getSelectionNameMap()
        Deprecated.
        Unused in the platform

      • getSelectionValues

        @Deprecated
List getSelectionValues()
        Deprecated.
        Unused in the platform

      • setParamSelections

        @Deprecated
void setParamSelections​(List selValues,
                        Map selNames,
                        String displayname)
        Deprecated.
        Unused in the platform