Class TaskParameterMetadataImpl

    • Constructor Detail

      • TaskParameterMetadataImpl

        public TaskParameterMetadataImpl()
        Constructs a TaskParameterMetadataImpl object.
      • TaskParameterMetadataImpl

        public TaskParameterMetadataImpl​(java.lang.String name)
        Constructs a TaskParameterMetadataImpl object.
        Parameters:
        name - The name of the task parameter.
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: TaskParameterMetadata
        Returns the name of this Task parameter.
        Specified by:
        getName in interface TaskParameterMetadata
        Returns:
        The name of this Task parameter.
      • isRequired

        public boolean isRequired()
        Description copied from interface: TaskParameterMetadata
        Whether this Task parameter is required, and must be supplied in all Task invocations.
        Specified by:
        isRequired in interface TaskParameterMetadata
        Returns:
        True, if this parameter is required; otherwise, false.
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: TaskParameterMetadata
        Returns the textual description of this Task parameter.
        Specified by:
        getDescription in interface TaskParameterMetadata
        Returns:
        The textual description of this Task parameter.
      • getDefaultValue

        public java.lang.String getDefaultValue()
        Description copied from interface: TaskParameterMetadata
        Get the default value associated with this parameter.
        Specified by:
        getDefaultValue in interface TaskParameterMetadata
        Returns:
        The default value, or null, if no default value is specified.
      • getDefaultValueObject

        public java.lang.Object getDefaultValueObject()
        Description copied from interface: TaskParameterMetadata
        Get the default generic object associated with this parameter.
        Specified by:
        getDefaultValueObject in interface TaskParameterMetadata
        Returns:
        The default value object, or null, if no default value is specified.
      • getValue

        public java.lang.String getValue​(RequestKeys requestKeys)
        Description copied from interface: TaskParameterMetadata
        Returns the value of a parameter, given the supplied input parameters. If the parameter has been explicitly specified in the input parameters, it is returned. If not, and the default value is non-null, then that is returned. Otherwise, null is returned.
        Specified by:
        getValue in interface TaskParameterMetadata
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        Returns:
        The computed value of the parameter for a specific request.
      • getValueObject

        public java.util.Enumeration getValueObject​(RequestKeys requestKeys)
        Description copied from interface: TaskParameterMetadata
        Returns the enumeration of value objects of a parameter, given the supplied input parameters. If the parameter has been explicitly specified in the input parameters, it is returned. If not, and the default value is non-null, then that is returned. Otherwise, null is returned.
        Specified by:
        getValueObject in interface TaskParameterMetadata
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        Returns:
        The computed value of the parameter for a specific request.
      • getType

        public java.lang.String getType()
        Description copied from interface: TaskParameterMetadata
        Returns the data type of this Task parameter.
        Specified by:
        getType in interface TaskParameterMetadata
        Returns:
        The data type of this Task parameter.
      • getValidator

        public java.lang.String getValidator()
        Description copied from interface: TaskParameterMetadata
        Returns the data type validator of this Task parameter.
        Specified by:
        getValidator in interface TaskParameterMetadata
        Returns:
        The the data type validator of this Task parameter.
      • setName

        public void setName​(java.lang.String name)
      • setDescription

        public void setDescription​(java.lang.String desc)
        Sets the description for a task parameter.
        Parameters:
        desc - The description to associate with this task parameter.
      • setRequired

        public void setRequired​(boolean required)
        Sets whether this parameter is required or not.
        Parameters:
        required - Whether this parameter is required or not.
      • setHidden

        public void setHidden​(boolean isHidden)
        Sets whether this parameter is private or not.
        Parameters:
        private - Whether this parameter is private or not.
      • setDefaultValue

        public void setDefaultValue​(java.lang.Object defValue)
        Specifies a default value for this parameter.
        Parameters:
        defValue - The value to use if none is supplied.
      • setDefaultValue

        public void setDefaultValue​(java.lang.String defValue)
        Deprecated.
        Specifies a default value for this parameter.
        Parameters:
        defValue - The value to use if none is supplied.
      • getKeyAttribute

        protected java.lang.String getKeyAttribute()
        Description copied from class: AbstractConfigurationElement
        This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
        Specified by:
        getKeyAttribute in class AbstractConfigurationElement
      • setType

        public void setType​(java.lang.String type)
      • setValidator

        public void setValidator​(java.lang.String validator)