Package com.microstrategy.web.tasks.config

Class TaskMetadataImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.tasks.config.TaskMetadataImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, TaskMetadata, java.lang.Cloneable

public class TaskMetadataImpl
extends AbstractConfigurationElementList
implements TaskMetadata

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.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NODE_BASIC_INFO

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

ATT_VERSION

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
TaskMetadataImpl()	Creates a new TaskMetadataImpl object.
TaskMetadataImpl(java.lang.String desc)	Creates a new TaskMetadataImpl object.

Method Summary

Modifier and Type	Method	Description
void	addParameterMetadata(TaskParameterMetadataImpl paramMetadataImpl)	Add the metadata object for a task parameter.
TaskParameterMetadataImpl	addParameterMetadata(java.lang.String name, java.lang.String desc, boolean required, java.lang.Object defValue)	Adds a new metadata object for a task parameter.
TaskParameterMetadataImpl	addParameterMetadata(java.lang.String name, java.lang.String desc, boolean required, java.lang.Object defValue, java.lang.String type, java.lang.String validator)	Adds a new metadata object for a task parameter.
TaskParameterMetadataImpl	addParameterMetadata(java.lang.String name, java.lang.String desc, boolean required, java.lang.String defValue)	Deprecated. Use addParameterMetadata(String, String, boolean, Object) instead
boolean	allRequiredParametersPresent(RequestKeys requestKeys)	Returns whether all required parameters are present.
java.lang.String	getDescription()	Returns the textual description of the purpose of this Task.
java.lang.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(int i)	Returns the metadata for a specific Task parameter.
TaskParameterMetadata	getParameterMetadata(java.lang.String paramName)	Returns the metadata for a specific Task parameter.
TaskParameterMetadata	getParameterMetadata(java.lang.String name, boolean create)	Gets a task parameter's metadata based on its name.
boolean	hasParameterMetadata(java.lang.String paramName)	Returns whether the metadata for a specific named Task parameter exists.
void	setDescription(java.lang.String desc)	Sets the description for this task.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

clear, clone, get, get, getFilteredList, getKey, getKeyAttribute, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, remove, setVersion, size, sort

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_BASIC_INFO

public static final java.lang.String NODE_BASIC_INFO

See Also:

Constant Field Values

Constructor Detail

TaskMetadataImpl

public TaskMetadataImpl()

Creates a new TaskMetadataImpl object.

TaskMetadataImpl

public TaskMetadataImpl(java.lang.String desc)

Creates a new TaskMetadataImpl object.

Parameters:

desc - The description for this task.

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: TaskMetadata

Returns the textual description of the purpose of this Task.

Specified by:

getDescription in interface TaskMetadata

Returns:

The textual description of this Task.

getParameterCount

public int getParameterCount()

Description copied from interface: TaskMetadata

Returns the number of parameters that this Task recognizes.

Specified by:

getParameterCount in interface TaskMetadata

Returns:

The number of parameters that this Task recognizes.

getParameterMetadata

public TaskParameterMetadata getParameterMetadata(int i)

Description copied from interface: TaskMetadata

Returns the metadata for a specific Task parameter.

Specified by:

getParameterMetadata in interface TaskMetadata

Parameters:

i - The index of the Task parameter to inspect.

Returns:

The TaskParameterMetadata object that provides information about the parameter.

hasParameterMetadata

public boolean hasParameterMetadata(java.lang.String paramName)

Description copied from interface: TaskMetadata

Returns whether the metadata for a specific named Task parameter exists.

Specified by:

hasParameterMetadata in interface TaskMetadata

Parameters:

paramName - The name of the parameter to check for.

Returns:

Whether the metadata for a specific named Task parameter exists.

getParameterMetadata

public TaskParameterMetadata getParameterMetadata(java.lang.String paramName)

Description copied from interface: TaskMetadata

Returns the metadata for a specific Task parameter.

Specified by:

getParameterMetadata in interface TaskMetadata

Parameters:

paramName - The name of the Task parameter to inspect.

Returns:

The TaskParameterMetadata object that provides information about the parameter.

setDescription

public void setDescription(java.lang.String desc)

Sets the description for this task.

Parameters:

desc - The description for this task.

getParameterMetadata

public TaskParameterMetadata getParameterMetadata(java.lang.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:

The TaskParameterMetadata for this parameter or null if non-existent and 'create' is false.

addParameterMetadata

public TaskParameterMetadataImpl addParameterMetadata(java.lang.String name,
                                                      java.lang.String desc,
                                                      boolean required,
                                                      java.lang.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:

The newly created TaskParameterMetadataImpl object. It has already been added to this task's collection.

addParameterMetadata

public TaskParameterMetadataImpl addParameterMetadata(java.lang.String name,
                                                      java.lang.String desc,
                                                      boolean required,
                                                      java.lang.Object defValue,
                                                      java.lang.String type,
                                                      java.lang.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:

The newly created TaskParameterMetadataImpl object. It has already been added to this task's collection.

addParameterMetadata

@Deprecated
public TaskParameterMetadataImpl addParameterMetadata(java.lang.String name,
                                                      java.lang.String desc,
                                                      boolean required,
                                                      java.lang.String defValue)

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:

The newly created TaskParameterMetadataImpl object. It has already been added to this task's collection.

addParameterMetadata

public void addParameterMetadata(TaskParameterMetadataImpl paramMetadataImpl)

Add the metadata object for a task parameter.

Parameters:

paramMetadataImpl - The TaskParameterMetadataImpl object for a specific task parameter.

allRequiredParametersPresent

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.

getMissingParameters

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