edu.illinois.ncsa.datawolf.domain

Class WorkflowToolParameter

java.lang.Object

edu.illinois.ncsa.domain.AbstractBean

edu.illinois.ncsa.datawolf.domain.WorkflowToolParameter

All Implemented Interfaces:

Serializable

public class WorkflowToolParameter
extends AbstractBean

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowToolParameter.ParameterType

Constructor Summary

Constructors

Constructor and Description
WorkflowToolParameter() Create a new instance of the workflow parameter.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Return the description of the workflow parameter.
List<String>	getOptions() Return the list of options for this parameter.
String	getParameterId() Return the id of the workflow parameter.
String	getTitle() Return the title of the workflow parameter.
WorkflowToolParameter.ParameterType	getType() Return the type of the workflow parameter.
String	getValue() Return the value of the workflow parameter.
boolean	isAllowNull() Return true if the parameter is allowed to be empty.
boolean	isHidden() Returns true if the workflow parameter should not be shown to the user.
void	setAllowNull(boolean allowNull) Sets whether or not the workflow parameter can be empty.
void	setDescription(String description) Sets the description of the workflow parameter.
void	setHidden(boolean hidden) Sets whether or not the workflow parameter should be shown to the user.
void	setOptions(List<String> options) Sets the list of options this parameter can be.
void	setParameterId(String paramid) Sets the id of the workflow parameter.
void	setTitle(String title) Sets the title of the workflow parameter.
void	setType(String type) Deprecated. see setType(ParameterType type)
void	setType(WorkflowToolParameter.ParameterType type) Sets the type of the workflow parameter.
void	setValue(String value) Sets the value of the workflow parameter.
String	toString()

Methods inherited from class edu.illinois.ncsa.domain.AbstractBean

equals, getId, hashCode, isDeleted, setDeleted, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkflowToolParameter

public WorkflowToolParameter()

Create a new instance of the workflow parameter.

Method Detail

getParameterId

public String getParameterId()

Return the id of the workflow parameter.

Returns:

id of the workflow parameter.

setParameterId

public void setParameterId(String paramid)

Sets the id of the workflow parameter.

Parameters:

title - sets the id of the workflow parameter.

getTitle

public String getTitle()

Return the title of the workflow parameter.

Returns:

title of the workflow parameter.

setTitle

public void setTitle(String title)

Sets the title of the workflow parameter.

Parameters:

title - sets the title of the workflow parameter.

getDescription

public String getDescription()

Return the description of the workflow parameter.

Returns:

description of the workflow parameter.

setDescription

public void setDescription(String description)

Sets the description of the workflow parameter.

Parameters:

description - sets the description of the workflow parameter.

getType

public WorkflowToolParameter.ParameterType getType()

Return the type of the workflow parameter.

Returns:

type of the workflow parameter.

setType

public void setType(WorkflowToolParameter.ParameterType type)

Sets the type of the workflow parameter.

Parameters:

type - sets the type of the workflow parameter.

setType

@Deprecated
public void setType(String type)

Deprecated. see setType(ParameterType type)

Sets the type of the workflow parameter.

Parameters:

type - sets the type of the workflow parameter.

getValue

public String getValue()

Return the value of the workflow parameter.

Returns:

value of the workflow parameter.

setValue

public void setValue(String value)

Sets the value of the workflow parameter.

Parameters:

value - sets the value of the workflow parameter.

isHidden

public boolean isHidden()

Returns true if the workflow parameter should not be shown to the user.

Returns:

true if the workflow parameter should not be shown.

setHidden

public void setHidden(boolean hidden)

Sets whether or not the workflow parameter should be shown to the user.

Parameters:

hidden - if set to true the workflow parameter will not be shown to the user.

isAllowNull

public boolean isAllowNull()

Return true if the parameter is allowed to be empty.

Returns:

the true if the parameter can be empty.

setAllowNull

public void setAllowNull(boolean allowNull)

Sets whether or not the workflow parameter can be empty.

Parameters:

allowNull - the allowNull to set

getOptions

public List<String> getOptions()

Return the list of options for this parameter.

Returns:

the list of options this parameter can be.

setOptions

public void setOptions(List<String> options)

Sets the list of options this parameter can be.

Parameters:

options - the list of options for this parameter.

toString

public String toString()

Overrides:

toString in class Object