Package com.microstrategy.web.app.tasks.config

Class ActualParameterInfo

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.tasks.config.ActualParameterInfo

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class ActualParameterInfo
extends AbstractConfigurationElement

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_ACTUAL_PARAMETER

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
ActualParameterInfo()	Constructs a ActualParameterInfo object.
ActualParameterInfo(java.lang.String name)	Creates a new ActualParameterInfo object.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getKeyAttribute()	This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
java.lang.String	getName()	Returns the name of the actual parameter being overriden.
java.lang.String	getSource()
java.lang.String	getValue()
java.lang.Object	resolveValue(int formalParameterType, BeanTaskRequestContext btrContext)	Returns the "resolved" value (if any) that should be set on the actual parameter that we are associated with.
void	setName(java.lang.String name)
void	setSource(java.lang.String source)
void	setValue(java.lang.String value)

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

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, 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

Field Detail

NODE_ACTUAL_PARAMETER

public static final java.lang.String NODE_ACTUAL_PARAMETER

See Also:

Constant Field Values

Constructor Detail

ActualParameterInfo

public ActualParameterInfo()

Constructs a ActualParameterInfo object.

ActualParameterInfo

public ActualParameterInfo(java.lang.String name)

Creates a new ActualParameterInfo object.

Parameters:

name - The name of the actual parameter that is being overriden.

Method Detail

getName

public java.lang.String getName()

Returns the name of the actual parameter being overriden.

Returns:

The name of the actual parameter being overriden.

setName

public void setName(java.lang.String name)

resolveValue

public java.lang.Object resolveValue(int formalParameterType,
                                     BeanTaskRequestContext btrContext)

Returns the "resolved" value (if any) that should be set on the actual parameter that we are associated with. A "resolved" value takes into account the "source" of the actual parameter's value. It may be an actual constant value or the value may be the value of a named parameter.

Parameters:

formalParameterType - The type of the formal parameter (see FormalParameter).

btrContext - The BeanTaskRequestContext object.

Returns:

An Object that, if non-null, should be assigned to the ActualParameter.

Throws:

java.lang.IllegalArgumentException - If the formalParameterType is not valid.

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

getSource

public java.lang.String getSource()

setSource

public void setSource(java.lang.String source)

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

Specified by:

getKeyAttribute in class AbstractConfigurationElement