Package com.microstrategy.web.transform

Interface FormalParameters

  • public interface FormalParameters
    The FormalParameters interface is a read-only collection, used to learn the nature of a set of existing formal parameters.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getCount

        int getCount()
        Returns the number of formal parameters in the collection.
        Returns:
        formal parameters contained in the collection.
        See Also:
        FormalParameter

      • getFormalParameter

        FormalParameter getFormalParameter​(int index)
                            throws java.lang.IndexOutOfBoundsException
        Retrieves a specific formal paramter by its numeric index.
        Parameters:
        index - the index of the object in collection.
        Returns:
        the FormalParameter object in the collection with the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - thrown if the index is invalid.

      • getFormalParameter

        FormalParameter getFormalParameter​(java.lang.String name)
                            throws java.lang.IllegalArgumentException
        Retrives a specific formal parameter by its name.
        Parameters:
        name - the name of the FormalParameter object.
        Returns:
        the FormalParameter object in the collection with the given name.
        Throws:
        java.lang.IllegalArgumentException - thrown if no formal parameter has the given name.

      • containsFormalParameter

        boolean containsFormalParameter​(java.lang.String name)
        Returns true if the collection contains the specified FormalParameter.
        Parameters:
        name - the name of FormalParameter whose presence in the collection is to be tested
        Returns:
        true if the collection contains the specified FormalParameter.