Package com.microstrategy.web.tasks

Interface TaskMetadata

  • All Known Implementing Classes:
    TaskMetadataImpl
    public interface TaskMetadata
    This interface provide information about a specific Task. This "metadata" is used for diagnostic and administrative purposes.
    Since:
    MicroStrategy Web 8.1.0

    • Method Detail

      • getDescription

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

      • getParameterCount

        int getParameterCount()
        Returns the number of parameters that this Task recognizes.
        Returns:
        The number of parameters that this Task recognizes.

      • getParameterMetadata

        TaskParameterMetadata getParameterMetadata​(int i)
        Returns the metadata for a specific Task parameter.
        Parameters:
        i - The index of the Task parameter to inspect.
        Returns:
        The TaskParameterMetadata object that provides information about the parameter.

      • hasParameterMetadata

        boolean hasParameterMetadata​(java.lang.String paramName)
        Returns whether the metadata for a specific named Task parameter exists.
        Parameters:
        paramName - The name of the parameter to check for.
        Returns:
        Whether the metadata for a specific named Task parameter exists.
        Since:
        MicroStrategy Web 9.0.0

      • getParameterMetadata

        TaskParameterMetadata getParameterMetadata​(java.lang.String paramName)
        Returns the metadata for a specific Task parameter.
        Parameters:
        paramName - The name of the Task parameter to inspect.
        Returns:
        The TaskParameterMetadata object that provides information about the parameter.