public class

TaskMetadataImpl

extends AbstractConfigurationElementList
implements TaskMetadata
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractConfigurationElementList
       ↳ com.microstrategy.web.tasks.config.TaskMetadataImpl

Class Overview

THIS CLASS IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE CLASS IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.

Summary

Constants
String NODE_BASIC_INFO
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
TaskMetadataImpl()
Creates a new TaskMetadataImpl object.
TaskMetadataImpl(String desc)
Creates a new TaskMetadataImpl object.
Public Methods
TaskParameterMetadataImpl addParameterMetadata(String name, String desc, boolean required, Object defValue, String type, String validator)
Adds a new metadata object for a task parameter.
void addParameterMetadata(TaskParameterMetadataImpl paramMetadataImpl)
Add the metadata object for a task parameter.
TaskParameterMetadataImpl addParameterMetadata(String name, String desc, boolean required, Object defValue)
Adds a new metadata object for a task parameter.
TaskParameterMetadataImpl addParameterMetadata(String name, String desc, boolean required, String defValue)
This method is deprecated. Use addParameterMetadata(String, String, boolean, Object) instead
boolean allRequiredParametersPresent(RequestKeys requestKeys)
Returns whether all required parameters are present.
String getDescription()
Returns the textual description of the purpose of this Task.
String getMissingParameters(RequestKeys requestKeys)
Builds up a list of missing REQUIRED parameters.
int getParameterCount()
Returns the number of parameters that this Task recognizes.
TaskParameterMetadata getParameterMetadata(String name, boolean create)
Gets a task parameter's metadata based on its name.
TaskParameterMetadata getParameterMetadata(String paramName)
Returns the metadata for a specific Task parameter.
TaskParameterMetadata getParameterMetadata(int i)
Returns the metadata for a specific Task parameter.
boolean hasParameterMetadata(String paramName)
Returns whether the metadata for a specific named Task parameter exists.
void setDescription(String desc)
Sets the description for this task.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile
From interface com.microstrategy.web.tasks.TaskMetadata

Constants

public static final String NODE_BASIC_INFO

Constant Value: "basicInfo"

Public Constructors

public TaskMetadataImpl ()

Creates a new TaskMetadataImpl object.

public TaskMetadataImpl (String desc)

Creates a new TaskMetadataImpl object.

Parameters
desc The description for this task.

Public Methods

public TaskParameterMetadataImpl addParameterMetadata (String name, String desc, boolean required, Object defValue, String type, String validator)

Adds a new metadata object for a task parameter.

Parameters
name The name of the task parameter.
desc The description of the task parameter.
required Whether the task is required or not.
defValue The default value if it is optional.
type The data type of the task parameter.
validator The validator to check whether the value for the parameter is valid.
Returns

public void addParameterMetadata (TaskParameterMetadataImpl paramMetadataImpl)

Add the metadata object for a task parameter.

Parameters
paramMetadataImpl The TaskParameterMetadataImpl object for a specific task parameter.

public TaskParameterMetadataImpl addParameterMetadata (String name, String desc, boolean required, Object defValue)

Adds a new metadata object for a task parameter.

Parameters
name The name of the task parameter.
desc The description of the task parameter.
required Whether the task is required or not.
defValue The default value if it is optional.
Returns

public TaskParameterMetadataImpl addParameterMetadata (String name, String desc, boolean required, String defValue)

This method is deprecated.
Use addParameterMetadata(String, String, boolean, Object) instead

Adds a new metadata object for a task parameter.

Parameters
name The name of the task parameter.
desc The description of the task parameter.
required Whether the task is required or not.
defValue The default value if it is optional.
Returns

public boolean allRequiredParametersPresent (RequestKeys requestKeys)

Returns whether all required parameters are present.

Parameters
requestKeys The RequestKeys object that is inspected.
Returns
  • True, if all required parameters are present; otherwise, false.

public String getDescription ()

Returns the textual description of the purpose of this Task.

Returns
  • The textual description of this Task.

public String getMissingParameters (RequestKeys requestKeys)

Builds up a list of missing REQUIRED parameters.

Parameters
requestKeys The RequestKeys to inspect.
Returns
  • A string of missing REQUIRED task parameters.

public int getParameterCount ()

Returns the number of parameters that this Task recognizes.

Returns
  • The number of parameters that this Task recognizes.

public TaskParameterMetadata getParameterMetadata (String name, boolean create)

Gets a task parameter's metadata based on its name.

Parameters
name The name of the task parameter.
create Whether or not we should create one if it is absent.
Returns

public TaskParameterMetadata getParameterMetadata (String paramName)

Returns the metadata for a specific Task parameter.

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

public TaskParameterMetadata getParameterMetadata (int i)

Returns the metadata for a specific Task parameter.

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

public 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.

public void setDescription (String desc)

Sets the description for this task.

Parameters
desc The description for this task.