Class ParameterValue

  • All Implemented Interfaces:
    java.io.Serializable

    public class ParameterValue
    extends java.lang.Object
    implements java.io.Serializable
    The class that represents a parameter value. A parameter value specifies the value of a job parameter when a job is submitted. The name specifies the job parameter name that is defined in the job. If a default value is defined for the job parameter, the default value is overridden by the value that is specified by the object.
    See Also:
    Serialized Form
    • Constructor Detail

      • ParameterValue

        public ParameterValue​(java.lang.String name,
                              java.io.Serializable value,
                              JobParameter.ParameterType type)
        The constructor.
        Parameters:
        name - The name of the parameter.
        value - The 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.
        type - The type of the parameter.
    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name of the parameter.
        Returns:
        The name.
      • setName

        public void setName​(java.lang.String name)
        Sets the name of the parameter.
        Parameters:
        name - The name.
      • getValue

        public java.io.Serializable getValue()
        Gets the value of the parameter.
        Returns:
        The default value.
      • setValue

        public void setValue​(java.io.Serializable value)
        Sets the value of the parameter.
      • The value specified must have types that are based on the parameter type :
      • FILE and FOLDER : The value must be specified as a JobInput.
      • CHARACTER and NUMERIC : The value must be specified as java.lang.String.
      • DATE : The value must be specified as java.util.Date.
Parameters:
value - The default value to set.