Package org.pentaho.platform.engine.services.actionsequence

Class ActionParameter

java.lang.Object

org.pentaho.platform.engine.services.actionsequence.ActionParameter

All Implemented Interfaces:

org.pentaho.platform.api.engine.IActionParameter

public class ActionParameter
extends Object
implements org.pentaho.platform.api.engine.IActionParameter

Field Summary

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

PROMPT_ALLOWED, PROMPT_NEEDED, PROMPT_NEVER, PROMPT_PENDING, TYPE_CONTENT, TYPE_DATE, TYPE_DECIMAL, TYPE_INTEGER, TYPE_LIST, TYPE_OBJECT, TYPE_RESULT_SET, TYPE_STRING

Constructor Summary

Constructors

Constructor	Description
ActionParameter(String name, String type, Object value, List variables, Object defaultValue)

Method Summary

Modifier and Type	Method	Description
void	addSaveLocation(String location)
void	dispose()
String	getName()
int	getPromptStatus()
int	getPromptType()
List	getSaveLocations()
String	getSelectionDisplayName()
String	getSelectionNameForValue(String val)
Map	getSelectionNameMap()
List	getSelectionValues()
String	getStringValue()
String	getType()
Object	getValue()
List	getValueAsList()
org.pentaho.commons.connection.IPentahoResultSet	getValueAsResultSet()
List	getVariables()
boolean	hasDefaultValue()
boolean	hasSelections()
boolean	hasValue()
boolean	isDefaultValue()
boolean	isNull()
boolean	isOutputParameter()
void	setOutputParameter(boolean isOutputParameter)
void	setParamSelections(List selValues, Map selNames, String displayname)	Deprecated.
boolean	setPromptStatus(int status)
void	setValue(Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionParameter

public ActionParameter(String name,
                       String type,
                       Object value,
                       List variables,
                       Object defaultValue)

Method Detail

getSaveLocations

public List getSaveLocations()

addSaveLocation

public void addSaveLocation(String location)

getVariables

public List getVariables()

Specified by:

getVariables in interface org.pentaho.platform.api.engine.IActionParameter

getName

public String getName()

Specified by:

getName in interface org.pentaho.platform.api.engine.IActionParameter

getType

public String getType()

Specified by:

getType in interface org.pentaho.platform.api.engine.IActionParameter

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface org.pentaho.platform.api.engine.IActionParameter

getValue

public Object getValue()

Specified by:

getValue in interface org.pentaho.platform.api.engine.IActionParameter

getValueAsList

public List getValueAsList()

Specified by:

getValueAsList in interface org.pentaho.platform.api.engine.IActionParameter

getValueAsResultSet

public org.pentaho.commons.connection.IPentahoResultSet getValueAsResultSet()

Specified by:

getValueAsResultSet in interface org.pentaho.platform.api.engine.IActionParameter

setValue

public void setValue(Object value)

Specified by:

setValue in interface org.pentaho.platform.api.engine.IActionParameter

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface org.pentaho.platform.api.engine.IActionParameter

hasValue

public boolean hasValue()

Specified by:

hasValue in interface org.pentaho.platform.api.engine.IActionParameter

isDefaultValue

public boolean isDefaultValue()

Specified by:

isDefaultValue in interface org.pentaho.platform.api.engine.IActionParameter

isNull

public boolean isNull()

Specified by:

isNull in interface org.pentaho.platform.api.engine.IActionParameter

dispose

public void dispose()

Specified by:

dispose in interface org.pentaho.platform.api.engine.IActionParameter

getPromptType

public int getPromptType()

hasSelections

public boolean hasSelections()

Specified by:

hasSelections in interface org.pentaho.platform.api.engine.IActionParameter

getSelectionDisplayName

public String getSelectionDisplayName()

Specified by:

getSelectionDisplayName in interface org.pentaho.platform.api.engine.IActionParameter

getSelectionNameForValue

public String getSelectionNameForValue(String val)

Specified by:

getSelectionNameForValue in interface org.pentaho.platform.api.engine.IActionParameter

getSelectionValues

public List getSelectionValues()

Specified by:

getSelectionValues in interface org.pentaho.platform.api.engine.IActionParameter

setParamSelections

@Deprecated
public void setParamSelections(List selValues,
                               Map selNames,
                               String displayname)

Deprecated.

Unused

Specified by:

setParamSelections in interface org.pentaho.platform.api.engine.IActionParameter

getSelectionNameMap

public Map getSelectionNameMap()

Specified by:

getSelectionNameMap in interface org.pentaho.platform.api.engine.IActionParameter

getPromptStatus

public int getPromptStatus()

Specified by:

getPromptStatus in interface org.pentaho.platform.api.engine.IActionParameter

setPromptStatus

public boolean setPromptStatus(int status)

Specified by:

setPromptStatus in interface org.pentaho.platform.api.engine.IActionParameter

isOutputParameter

public boolean isOutputParameter()

Specified by:

isOutputParameter in interface org.pentaho.platform.api.engine.IActionParameter

setOutputParameter

public void setOutputParameter(boolean isOutputParameter)