Package com.sas.lsaf.execution.job

Class JobParameter

java.lang.Object

com.sas.lsaf.execution.job.JobParameter

All Implemented Interfaces:

Serializable

public class JobParameter
extends Object
implements Serializable

The client representation of a job parameter.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JobParameter.ParameterType

Constructor Summary

Constructors

Constructor	Description
JobParameter(String name, String label, JobParameter.ParameterType type)	The constructor.
JobParameter(String name, String label, JobParameter.ParameterType type, Serializable defaultValue)	The constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Serializable	getDefaultValue()	Gets the default value of the parameter.
String	getLabel()	Gets the label for the parameter.
String	getName()	Gets the name of the parameter.
JobParameter.ParameterType	getType()	Gets the type of the parameter.
int	hashCode()
void	setDefaultValue(Serializable defaultValue)	Sets the default value of the parameter.
void	setLabel(String label)	Sets the label for the parameter.
void	setName(String name)	Sets the name of the parameter.
void	setType(JobParameter.ParameterType type)	Sets the type of the parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JobParameter

public JobParameter(String name,
 String label,
 JobParameter.ParameterType type,
 Serializable defaultValue)

The constructor.

Parameters:

name - The name of the parameter.

label - The label for the parameter.

type - The type of the parameter.

defaultValue - The default value for the parameter. For parameters of type FILE and FOLDER, the value must be specified as a JobInput. The values of CHARACTER and NUMERIC parameters must be specified as a String. The DATE parameter values must be specified as java.util.Date.

JobParameter

public JobParameter(String name,
 String label,
 JobParameter.ParameterType type)

The constructor.

Parameters:

name - The name of the parameter.

label - The label for the parameter.

type - The type of the parameter.

Method Details

getName

public String getName()

Gets the name of the parameter.

Returns:

The name.

setName

public void setName(String name)

Sets the name of the parameter.

Parameters:

name - The name.

getDefaultValue

public Serializable getDefaultValue()

Gets the default value of the parameter. The value must be cast to the appropriate class based on the parameter type.
For parameters of type FILE and FOLDER, the value must be specified as a JobInput. The values of CHARACTER and NUMERIC parameters must be specified as a String. The DATE parameter values must be specified as java.util.Date.

Returns:

The default value.

setDefaultValue

public void setDefaultValue(Serializable defaultValue)

Sets the default value of the parameter. For parameters of type FILE and FOLDER, the value must be specified as a JobInput. The values of CHARACTER and NUMERIC parameters must be specified as a String. The DATE parameter values must be specified as java.util.Date.

Parameters:

defaultValue - The default value.

getType

public JobParameter.ParameterType getType()

Gets the type of the parameter.

Returns:

The type.

setType

public void setType(JobParameter.ParameterType type)

Sets the type of the parameter.

Parameters:

type - The type.

setLabel

public void setLabel(String label)

Sets the label for the parameter.

Parameters:

label - The label.

getLabel

public String getLabel()

Gets the label for the parameter.

Returns:

The label.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object