Package com.microstrategy.web.tasks

Interface TaskParameterMetadata

  • All Known Implementing Classes:
    TaskParameterMetadataImpl
    public interface TaskParameterMetadata
    This interface provides information about a specific Task parameter. This "metadata" can be used for diagnostic and adminstrative purposes.
    Since:
    MicroStrategy Web 8.1.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getArrayValue​(RequestKeys requestKeys)
      Returns an array of string values by parsing the parameter value.
      java.lang.String[] getArrayValue​(RequestKeys requestKeys, java.lang.String delim)
      Returns an array of string values by parsing the parameter value and using the specified delimiter.
      boolean getBooleanValue​(RequestKeys requestKeys)
      Returns the boolean value of a parameter.
      java.lang.String getDefaultValue()
      Get the default value associated with this parameter.
      java.lang.Object getDefaultValueObject()
      Get the default generic object associated with this parameter.
      java.lang.String getDescription()
      Returns the textual description of this Task parameter.
      int getIntValue​(RequestKeys requestKeys)
      Returns the integer value of a parameter.
      long getLongValue​(RequestKeys requestKeys)
      Returns the long value of a parameter.
      java.lang.String getName()
      Returns the name of this Task parameter.
      PostedFile getPostedFile​(TaskRequestContext context)
      Returns data file uploaded by user via a "multipart/form-data" request form.
      java.lang.String getType()
      Returns the data type of this Task parameter.
      java.lang.String getValidator()
      Returns the data type validator of this Task parameter.
      java.lang.String getValue​(RequestKeys requestKeys)
      Returns the value of a parameter, given the supplied input parameters.
      java.util.Enumeration getValueObject​(RequestKeys requestKeys)
      Returns the enumeration of value objects of a parameter, given the supplied input parameters.
      boolean isHidden()  
      boolean isRequired()
      Whether this Task parameter is required, and must be supplied in all Task invocations.

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of this Task parameter.
        Returns:
        The name of this Task parameter.

      • isRequired

        boolean isRequired()
        Whether this Task parameter is required, and must be supplied in all Task invocations.
        Returns:
        True, if this parameter is required; otherwise, false.

      • isHidden

        boolean isHidden()

      • getDescription

        java.lang.String getDescription()
        Returns the textual description of this Task parameter.
        Returns:
        The textual description of this Task parameter.

      • getDefaultValue

        java.lang.String getDefaultValue()
        Get the default value associated with this parameter.
        Returns:
        The default value, or null, if no default value is specified.

      • getValue

        java.lang.String getValue​(RequestKeys requestKeys)
        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.
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        Returns:
        The computed value of the parameter for a specific request.

      • getIntValue

        int getIntValue​(RequestKeys requestKeys)
         throws TaskRequestMalformedException
        Returns the integer value of a parameter. If not specified, a parameter's default value may be used.
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        Returns:
        An integer value for the parameter.
        Throws:
        TaskRequestMalformedException - If the value cannot be converted to an integer. This condition indicates that the caller did not make a valid Task invocation.
        See Also:
        getValue(RequestKeys)

      • getLongValue

        long getLongValue​(RequestKeys requestKeys)
           throws TaskRequestMalformedException
        Returns the long value of a parameter. If not specified, a parameter's default value may be used.
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        Returns:
        A long (integer) value for the parameter.
        Throws:
        TaskRequestMalformedException - If the value cannot be converted to a long. This condition indicates that the caller did not make a valid Task invocation.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        getValue(RequestKeys)

      • getBooleanValue

        boolean getBooleanValue​(RequestKeys requestKeys)
                 throws TaskRequestMalformedException
        Returns the boolean value of a parameter. If not specified, a parameter's default value may be used.
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        Returns:
        A boolean value for the parameter.
        Throws:
        TaskRequestMalformedException - If the value cannot be converted to a boolean value. This condition indicates that the caller did not make a valid Task invocation.

      • getArrayValue

        java.lang.String[] getArrayValue​(RequestKeys requestKeys,
                                 java.lang.String delim)
        Returns an array of string values by parsing the parameter value and using the specified delimiter.
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        delim - The String delimiter used to separate array elements.
        Returns:
        An array of Strings (without delimiters included).
        See Also:
        getValue(RequestKeys)

      • getArrayValue

        java.lang.String[] getArrayValue​(RequestKeys requestKeys)
        Returns an array of string values by parsing the parameter value. It assumes that array elements are separated (delimited) by commas.
        Parameters:
        requestKeys -
        Returns:
        An array of Strings (without delimiters included).
        See Also:
        getArrayValue(RequestKeys, String)

      • getDefaultValueObject

        java.lang.Object getDefaultValueObject()
        Get the default generic object associated with this parameter.
        Returns:
        The default value object, or null, if no default value is specified.
        Since:
        MicroStrategy Web 9.0.0

      • getValueObject

        java.util.Enumeration getValueObject​(RequestKeys requestKeys)
        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.
        Parameters:
        requestKeys - A RequestKeys object that contains the input parameters.
        Returns:
        The computed value of the parameter for a specific request.
        Since:
        MicroStrategy Web 9.0.0

      • getPostedFile

        PostedFile getPostedFile​(TaskRequestContext context)
        Returns data file uploaded by user via a "multipart/form-data" request form. Note that PostedFile is always returned even if the user uploaded nothing - PostedFile.getLength() should be checked for non-zero to indicate existence of data.
        Returns:
        the data uploaded with "multipart/form-data".

      • getType

        java.lang.String getType()
        Returns the data type of this Task parameter.
        Returns:
        The data type of this Task parameter.

      • getValidator

        java.lang.String getValidator()
        Returns the data type validator of this Task parameter.
        Returns:
        The the data type validator of this Task parameter.