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

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

All Implemented Interfaces:

IOutputDef

public class OutputDef
extends Object
implements IOutputDef

Constructor Summary

OutputDef(String name, List list)

OutputDef(String name, OutputStream outputStream)

OutputDef(String name, String type)

Method Summary

void	addToList(Object listItem) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputDef

public OutputDef(String name,
                 OutputStream outputStream)

OutputDef

public OutputDef(String name,
                 List list)

OutputDef

public OutputDef(String name,
                 String type)

Method Detail

getType

public String getType()

Description copied from interface: IOutputDef

Retrieves the type of the output parameter.

Specified by:

getType in interface IOutputDef

Returns:

the output parameter type

getName

public String getName()

Description copied from interface: IOutputDef

Retrieves the name of the output parameter.

Specified by:

getName in interface IOutputDef

Returns:

the name of the ouotput parameter

isList

public boolean isList()

Description copied from interface: IOutputDef

Determine whether the value associated with this parameter is a list or not.

Specified by:

isList in interface IOutputDef

Returns:

rue if the parameter value is a list, otherwise false

setValue

public void setValue(Object value)

Description copied from interface: IOutputDef

Sets the value of the output parameter.

Specified by:

setValue in interface IOutputDef

Parameters:

value - the value to set

getOutputStream

public OutputStream getOutputStream()

Description copied from interface: IOutputDef

Retrieve the OutputStream associated with this output parameter.

Specified by:

getOutputStream in interface IOutputDef

Returns:

the OutputStream for this parameter

addToList

public void addToList(Object listItem)

Description copied from interface: IOutputDef

Adds the given value to the value list for this output parameter.

Specified by:

addToList in interface IOutputDef

Parameters:

listItem - value to add to the parameter value list.