Package com.microstrategy.web.transform

Interface FormalParameter

  • All Known Implementing Classes:
    FormalParameterImpl
    public interface FormalParameter
    The FormalParameter interface defines the structure of a single formal parameter.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PARAM_TYPE_BOOLEAN
      Specifies that the formal parameter type is boolean.
      static int PARAM_TYPE_FLOAT
      Specifies that the formal parameter type is float.
      static int PARAM_TYPE_INTEGER
      Specifies that the formal parameter type is integer.
      static int PARAM_TYPE_STRING
      Specifies that the formal parameter type is string.
      static int PARAM_TYPE_UNKNOWN
      Specifies that the formal parameter type is unkown.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void checkValue​(java.lang.Object value)
      Checks if the value corresponds to the type of the formal parameter.
      java.lang.Object getDefaultValue()
      Returns the default value used in the abscence of an explicit value.
      java.lang.String getDescription()
      Returns the description of the FormalParameter object.
      java.lang.String getName()
      Returns the FormalParameter object name.
      int getType()
      Returns the value type of the FormalParameter object.
      java.lang.Object getValue()
      Returns the actual value of the FormalParameter object..
      boolean isRequired()
      Indicates if a parameter value is required for the execution of the transform.
      java.lang.String paramTypeToString​(int paramType)
      Returns the value type converted into a string form.
      void setValue​(java.lang.Object value)
      Sets an actual value of a formal parameter.

    • Field Detail

      • PARAM_TYPE_UNKNOWN

        static final int PARAM_TYPE_UNKNOWN
        Specifies that the formal parameter type is unkown.
        See Also:
        Constant Field Values

      • PARAM_TYPE_STRING

        static final int PARAM_TYPE_STRING
        Specifies that the formal parameter type is string.
        See Also:
        Constant Field Values

      • PARAM_TYPE_INTEGER

        static final int PARAM_TYPE_INTEGER
        Specifies that the formal parameter type is integer.
        See Also:
        Constant Field Values

      • PARAM_TYPE_FLOAT

        static final int PARAM_TYPE_FLOAT
        Specifies that the formal parameter type is float.
        See Also:
        Constant Field Values

      • PARAM_TYPE_BOOLEAN

        static final int PARAM_TYPE_BOOLEAN
        Specifies that the formal parameter type is boolean.
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the FormalParameter object name.
        Returns:
        the FormalParameter object name.

      • getType

        int getType()
        Returns the value type of the FormalParameter object.
        Returns:
        value type of the FormalParameter object.

      • paramTypeToString

        java.lang.String paramTypeToString​(int paramType)
        Returns the value type converted into a string form.
        Parameters:
        paramType - the type of the FormalParameter object.
        Returns:
        type of the FormalParameter object as String.

      • getDescription

        java.lang.String getDescription()
        Returns the description of the FormalParameter object.
        Returns:
        description of the FormalParameter object.

      • isRequired

        boolean isRequired()
        Indicates if a parameter value is required for the execution of the transform.
        Returns:
        whether the transform requires a specific parameter value.

      • getDefaultValue

        java.lang.Object getDefaultValue()
        Returns the default value used in the abscence of an explicit value.
        Returns:
        default value of the formal parameter.

      • getValue

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

      • setValue

        void setValue​(java.lang.Object value)
       throws java.lang.IllegalArgumentException
        Sets an actual value of a formal parameter.
        Parameters:
        value - the actual value of the FormalParameter
        Throws:
        java.lang.IllegalArgumentException - thrown if the value supplied is malformed.

      • checkValue

        void checkValue​(java.lang.Object value)
         throws java.lang.IllegalArgumentException
        Checks if the value corresponds to the type of the formal parameter.
        Parameters:
        value - the value wanted to be checked.
        Throws:
        java.lang.IllegalArgumentException - thrown if the value supplied is malformed.