public interface

ActualParameter

implements ConfigurationElement
com.microstrategy.web.transform.ActualParameter
Known Indirect Subclasses

Class Overview

The ActualParameter interface exposes the information on an actual parameter object.

Summary

Public Methods
abstract String getCatalogValue()
Returns the value of the actual parameter as registered in the StyleCatalog object.
abstract FormalParameter getFormalParam(Transform transform)
Returns the formal parameter object of a supplied Transform that is associated with the actual parameter.
abstract FormalParameter getFormalParam()
Returns the formal parameter object associated with the actual parameter.
abstract String getName()
Returns the name of the actual parameter object.
abstract int getOrder()
This method is deprecated. The order is not used anymore as there can only bbe one actual parameter for a single formal parameter.
abstract String getSource()
Returns the source name to look up the SourceLookup object registered in the current StyleCatalog object.
abstract Object getValue()
Returns the value of the actual parameter.
abstract Object getValue(StyleRequestContext context)
Returns the value of the actual parameter in the given context
abstract boolean hasValue()
Returns whether the actual parameter has a value.
abstract boolean hasValue(StyleRequestContext context)
Returns whether the actual parameter has a value based on the context.
abstract boolean isMatched()
Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter.
abstract boolean isMatched(StyleRequestContext context)
Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter in the given context.
abstract void setCatalogValue(String value)
Sets the value of the actual parameter to be saved in the StyleCatalog object.
abstract void setFormalParam(FormalParameter param)
This method is deprecated. The FormalParameter should not be explicitly set, it should be resolved automatically by the ActualParameter.
abstract void setOrder(int order)
This method is deprecated. The order is not used anymore as there can only bbe one actual parameter for a single formal parameter.
abstract void setSource(String source)
Sets the source name to look up the SourceLookup object registered in the current StyleCatalog object.
abstract void setValue(Object value)
This method is deprecated. The value should not be set explicitly. It should be calculated automatically by the ActualParameter.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract String getCatalogValue ()

Returns the value of the actual parameter as registered in the StyleCatalog object.

Returns
  • the value of the actual parameter.

public abstract FormalParameter getFormalParam (Transform transform)

Returns the formal parameter object of a supplied Transform that is associated with the actual parameter.

Parameters
transform The Transform object to use for finding formal parameters.
Returns

public abstract FormalParameter getFormalParam ()

Returns the formal parameter object associated with the actual parameter.

Returns

public abstract String getName ()

Returns the name of the actual parameter object.

Returns
  • the name of the actual parameter object.

public abstract int getOrder ()

This method is deprecated.
The order is not used anymore as there can only bbe one actual parameter for a single formal parameter.

Returns the precedence of the actual parameter. This precedence is used to resolve which actual parameter to use if there are multiple actual parameters matching the same formal parameter. Higher this number, higher precedence.

Returns
  • the precedence of the actual parameter.

public abstract String getSource ()

Returns the source name to look up the SourceLookup object registered in the current StyleCatalog object.

Returns
  • the source name to look up the SourceLookup object.

public abstract Object getValue ()

Returns the value of the actual parameter.

Returns
  • the value of the actual parameter.

public abstract Object getValue (StyleRequestContext context)

Returns the value of the actual parameter in the given context

Returns
  • the value of the actual parameter.

public abstract boolean hasValue ()

Returns whether the actual parameter has a value.

Returns
  • whether the actual parameter has a value.

public abstract boolean hasValue (StyleRequestContext context)

Returns whether the actual parameter has a value based on the context.

Returns
  • whether the actual parameter has a value.

public abstract boolean isMatched ()

Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter.

Returns
  • whether the name matches or not with a formal parameter.

public abstract boolean isMatched (StyleRequestContext context)

Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter in the given context.

Returns
  • whether the name matches or not with a formal parameter.

public abstract void setCatalogValue (String value)

Sets the value of the actual parameter to be saved in the StyleCatalog object.

Parameters
value the value of the actual parameter.

public abstract void setFormalParam (FormalParameter param)

This method is deprecated.
The FormalParameter should not be explicitly set, it should be resolved automatically by the ActualParameter.

Associates the formal parameter object with this actual parameter.

Parameters
param the FormalParameter object associated with this actual parameter.
Throws
IllegalArgumentException

public abstract void setOrder (int order)

This method is deprecated.
The order is not used anymore as there can only bbe one actual parameter for a single formal parameter.

Sets a precedence to the actual parameter. This precedence is used to resolve which actual parameter to use if there are multiple actual parameters matching the same formal parameter. Higher this number, higher precedence.

Parameters
order the precedence of the actual parameter.

public abstract void setSource (String source)

Sets the source name to look up the SourceLookup object registered in the current StyleCatalog object.

Parameters
source the source name to look up the SourceLookup object.

public abstract void setValue (Object value)

This method is deprecated.
The value should not be set explicitly. It should be calculated automatically by the ActualParameter.

Sets the value of the actual parameter.

Parameters
value the value of the actual parameter.
Throws
IllegalArgumentException thrown if the value is null.