public class

ActualParameterInfo

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.tasks.config.ActualParameterInfo

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_ACTUAL_PARAMETER
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ActualParameterInfo()
Constructs a ActualParameterInfo object.
ActualParameterInfo(String name)
Creates a new ActualParameterInfo object.
Public Methods
String getName()
Returns the name of the actual parameter being overriden.
String getSource()
String getValue()
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(String name)
void setSource(String source)
void setValue(String value)
Protected Methods
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.
[Expand]
Inherited Methods
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.ConfigurationFile

Constants

public static final String NODE_ACTUAL_PARAMETER

Constant Value: "actualParameter"

Public Constructors

public ActualParameterInfo ()

Constructs a ActualParameterInfo object.

public ActualParameterInfo (String name)

Creates a new ActualParameterInfo object.

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

Public Methods

public String getName ()

Returns the name of the actual parameter being overriden.

Returns
  • The name of the actual parameter being overriden.

public String getSource ()

public String getValue ()

public 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
IllegalArgumentException If the formalParameterType is not valid.

public void setName (String name)

public void setSource (String source)

public void setValue (String value)

Protected Methods

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