com.sas.hls.job
Class JobParameter

java.lang.Object
  extended by com.sas.hls.job.JobParameter
All Implemented Interfaces:
Serializable

public class JobParameter
extends Object
implements Serializable

Client representation of a job parameter.

See Also:
Serialized Form

Constructor Summary
JobParameter(String name, ParameterType type, String label)
          Constructor
JobParameter(String name, Serializable defaultValue, ParameterType type, String label)
          Constructor
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 Serializable getDefaultValue()
          Get the default value of the parameter.
 String getLabel()
          Get the label for this parameter.
 String getName()
          Get the name of the parameter.
 ParameterType getType()
          Get the type of the parameter.
 int hashCode()
          Return a hash code value for the object.
 void setDefaultValue(Serializable defaultValue)
          Set the default value of the parameter.
 void setLabel(String label)
          Set the label for this parameter.
 void setName(String name)
          Set the name of the parameter.
 void setType(ParameterType type)
          Set the type of the parameter.
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JobParameter

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

Parameters:
name - Name of the parameter.
defaultValue - The default value for the parameter. For parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values of CHARACTER and NUMERIC parameters should be specified as a String. DATE parameter values should be specified as java.util.Date.
type - The type of the parameter.
label - The label for the parameter.

JobParameter

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

Parameters:
name - Name of the parameter.
type - The type of the parameter.
label - The label for the parameter.
Method Detail

getName

public String getName()
Get the name of the parameter.

Returns:
Returns the name.

setName

public void setName(String name)
Set the name of the parameter.

Parameters:
name - The name to set.

getDefaultValue

public Serializable getDefaultValue()
Get the default value of the parameter. This will need to be cast to the appropriate class based on the parameter type.

Returns:
Returns the defaultValue.

setDefaultValue

public void setDefaultValue(Serializable defaultValue)
Set the default value of the parameter. For parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values of CHARACTER and NUMERIC parameters should be specified as a String. DATE parameter values should be specified as java.util.Date.

Parameters:
defaultValue - The defaultValue to set.

getType

public ParameterType getType()
Get the type of the parameter.

Returns:
Returns the type.

setType

public void setType(ParameterType type)
Set the type of the parameter.

Parameters:
type - the type of the parameter.

setLabel

public void setLabel(String label)
Set the label for this parameter.

Parameters:
label - the label to set for this parameter

getLabel

public String getLabel()
Get the label for this parameter.

Returns:
the label for this parameter.

hashCode

public int hashCode()
Return a hash code value for the object.

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright (c) 2016, SAS Institute Inc., Cary, NC, USA