com.sas.hls.job
Class ParameterValue

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

public class ParameterValue
extends Object
implements Serializable

Parameter value is used to specify value of job parameter when a job is submitted. The name specifies the job parameter name defined within the job. If a default value was defined for the job parameter, it will be overridden by the value specified by this object.

See Also:
Serialized Form

Constructor Summary
ParameterValue(String name, Serializable value, ParameterType type)
          Constructor
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 String getName()
          Get the name of the parameter.
 ParameterType getType()
          Get the type of the parameter.
 Serializable getValue()
          Get the value of the parameter.
 int hashCode()
          Return a hash code value for the object.
 void setName(String name)
          Set the name of the parameter.
 void setType(ParameterType type)
          Set the type of the parameter.
 void setValue(Serializable value)
          Set the value 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

ParameterValue

public ParameterValue(String name,
                      Serializable value,
                      ParameterType type)
Constructor

Parameters:
name - Name of the parameter.
value - 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.
type - The type of 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.

getValue

public Serializable getValue()
Get the value of the parameter.

Returns:
Returns the defaultValue.

setValue

public void setValue(Serializable value)
Set the value of the parameter.
  • The value specified should have the following types based on the parameter type :
  • FILE and FOLDER : the value should be specified as com.sas.hls.resource.ResourceSpecification. See ResourceSpecification
  • CHARACTER and NUMERIC : value should be specified as java.lang.String.
  • DATE : value should be specified as java.util.Date.

    Parameters:
    value - The defaultValue to set.

  • setType

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

    Parameters:
    type - the type of the parameter.

    getType

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

    Returns:
    the type of the 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) 2013, SAS Institute Inc., Cary, NC, USA