Package org.pentaho.platform.api.engine

Interface IOutputDef

public interface IOutputDef
An OutputDef represents one output parameter in a SequenceDefinition or ActionDefinition.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addToList(Object value)
    Adds the given value to the value list for this output parameter.
    String
    getName()
    Retrieves the name of the output parameter.
    OutputStream
    getOutputStream()
    Retrieve the OutputStream associated with this output parameter.
    String
    getType()
    Retrieves the type of the output parameter.
    boolean
    isList()
    Determine whether the value associated with this parameter is a list or not.
    void
    setValue(Object value)
    Sets the value of the output parameter.

  • Method Details

    • getType

      String getType()
      Retrieves the type of the output parameter.
      Returns:
      the output parameter type

    • getName

      String getName()
      Retrieves the name of the output parameter.
      Returns:
      the name of the ouotput parameter

    • isList

      boolean isList()
      Determine whether the value associated with this parameter is a list or not.
      Returns:
      rue if the parameter value is a list, otherwise false

    • setValue

      void setValue(Object value)
      Sets the value of the output parameter.
      Parameters:
      value - the value to set

    • getOutputStream

      OutputStream getOutputStream()
      Retrieve the OutputStream associated with this output parameter.
      Returns:
      the OutputStream for this parameter

    • addToList

      void addToList(Object value)
      Adds the given value to the value list for this output parameter.
      Parameters:
      value - value to add to the parameter value list.