net.proteusframework.core.automation

Class TaskArgument

java.lang.Object

net.proteusframework.core.automation.TaskArgument

public final class TaskArgument
extends Object

Represents an argument for an AbstractTask.

Author:

Russ Tennant (russ@i2rd.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_DATA_CONVERSION_USER_ID Default TaskArgument Name.
static String	NAME_DEFAULT_DATASOURCE Default TaskArgument Name.

Constructor Summary

Constructors

Constructor and Description
TaskArgument() Constructor.
TaskArgument(String name, String description, Object argument, TaskArgumentRenderer renderer) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	getArgument() The argument value.
String	getDescription() Get the description of the argument.
String	getName() Get the name of the argument.
TaskArgumentRenderer	getRenderer() Get the renderer.
int	hashCode()
void	setArgument(Object argument) Set the argument value.
void	setDescription(String description) Set the description of the argument.
void	setName(String name) Set the name of the argument.
void	setRenderer(TaskArgumentRenderer renderer) Set the renderer.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_DATA_CONVERSION_USER_ID

public static final String NAME_DATA_CONVERSION_USER_ID

Default TaskArgument Name.

See Also:

Constant Field Values

NAME_DEFAULT_DATASOURCE

public static final String NAME_DEFAULT_DATASOURCE

Default TaskArgument Name.

See Also:

Constant Field Values

Constructor Detail

TaskArgument

public TaskArgument()

Constructor.

TaskArgument

public TaskArgument(String name,
                    String description,
                    Object argument,
                    @Nullable
                    TaskArgumentRenderer renderer)

Constructor.

Parameters:

name - argument name.

description - the description of the argument.

argument - the argument supplied by the user or a default.

renderer - the renderer.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getArgument

public Object getArgument()

The argument value.

Returns:

the argument.

getDescription

public String getDescription()

Get the description of the argument.

Returns:

the description.

getName

public String getName()

Get the name of the argument.

Returns:

the name the name.

getRenderer

public TaskArgumentRenderer getRenderer()

Get the renderer.

Returns:

the renderer.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setArgument

public void setArgument(Object argument)

Set the argument value.

Parameters:

argument - the argument.

setDescription

public void setDescription(String description)

Set the description of the argument.

Parameters:

description - the description.

setName

public void setName(String name)

Set the name of the argument.

Parameters:

name - the name.

setRenderer

public void setRenderer(TaskArgumentRenderer renderer)

Set the renderer.

Parameters:

renderer - the renderer.