Summary: Methods | [Expand All]
public interface

TaskMetadata

com.microstrategy.web.tasks.TaskMetadata
Known Indirect Subclasses

Class Overview

This interface provide information about a specific Task. This "metadata" is used for diagnostic and administrative purposes.

Summary

Public Methods
abstract String getDescription()
Returns the textual description of the purpose of this Task.
abstract int getParameterCount()
Returns the number of parameters that this Task recognizes.
abstract TaskParameterMetadata getParameterMetadata(int i)
Returns the metadata for a specific Task parameter.
abstract TaskParameterMetadata getParameterMetadata(String paramName)
Returns the metadata for a specific Task parameter.
abstract boolean hasParameterMetadata(String paramName)
Returns whether the metadata for a specific named Task parameter exists.

Public Methods

public abstract String getDescription ()

Returns the textual description of the purpose of this Task.

Returns
  • The textual description of this Task.

public abstract int getParameterCount ()

Returns the number of parameters that this Task recognizes.

Returns
  • The number of parameters that this Task recognizes.

public abstract TaskParameterMetadata getParameterMetadata (int i)

Returns the metadata for a specific Task parameter.

Parameters
i The index of the Task parameter to inspect.
Returns

public abstract TaskParameterMetadata getParameterMetadata (String paramName)

Returns the metadata for a specific Task parameter.

Parameters
paramName The name of the Task parameter to inspect.
Returns

public abstract boolean hasParameterMetadata (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.