Package com.microstrategy.web.transform

Interface ActualParameter

  • All Superinterfaces:
    java.lang.Cloneable, ConfigurationElement
    All Known Implementing Classes:
    ActualParameterImpl
    public interface ActualParameter
extends ConfigurationElement
    The ActualParameter interface exposes the information on an actual parameter object.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of the actual parameter object.
        Returns:
        the name of the actual parameter object.

      • getFormalParam

        FormalParameter getFormalParam()
        Returns the formal parameter object associated with the actual parameter.
        Returns:
        the FormalParameter object associated with the acutal parameter.

      • getFormalParam

        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:
        the FormalParameter object associated with the acutal parameter.

      • setFormalParam

        void setFormalParam​(FormalParameter param)
             throws java.lang.IllegalArgumentException
        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:
        java.lang.IllegalArgumentException

      • isMatched

        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.

      • isMatched

        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.
        Since:
        MicroStrategy Web 9.0.0

      • getValue

        java.lang.Object getValue()
        Returns the value of the actual parameter.
        Returns:
        the value of the actual parameter.

      • getValue

        java.lang.Object getValue​(StyleRequestContext context)
        Returns the value of the actual parameter in the given context
        Returns:
        the value of the actual parameter.
        Since:
        MicroStrategy Web 9.0.0

      • setValue

        void setValue​(java.lang.Object value)
       throws java.lang.IllegalArgumentException
        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:
        java.lang.IllegalArgumentException - thrown if the value is null.

      • hasValue

        boolean hasValue()
        Returns whether the actual parameter has a value.
        Returns:
        whether the actual parameter has a value.

      • hasValue

        boolean hasValue​(StyleRequestContext context)
        Returns whether the actual parameter has a value based on the context.
        Returns:
        whether the actual parameter has a value.
        Since:
        MicroStrategy Web 9.0.0

      • getOrder

        int getOrder()
        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.
        Since:
        MicroStrategy Web 8.0.0

      • setOrder

        void setOrder​(int order)
        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.
        Since:
        MicroStrategy Web 8.0.0

      • getSource

        java.lang.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.
        Since:
        MicroStrategy Web 8.0.0

      • setSource

        void setSource​(java.lang.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.
        Since:
        MicroStrategy Web 8.0.0

      • getCatalogValue

        java.lang.String getCatalogValue()
        Returns the value of the actual parameter as registered in the StyleCatalog object.
        Returns:
        the value of the actual parameter.
        Since:
        MicroStrategy Web 9.0.0

      • setCatalogValue

        void setCatalogValue​(java.lang.String value)
        Sets the value of the actual parameter to be saved in the StyleCatalog object.
        Parameters:
        value - the value of the actual parameter.
        Since:
        MicroStrategy Web 9.0.0