public interface

FormalParameters

com.microstrategy.web.transform.FormalParameters

Class Overview

The FormalParameters interface is a read-only collection, used to learn the nature of a set of existing formal parameters.

Summary

Public Methods
abstract boolean containsFormalParameter(String name)
Returns true if the collection contains the specified FormalParameter.
abstract int getCount()
Returns the number of formal parameters in the collection.
abstract FormalParameter getFormalParameter(int index)
Retrieves a specific formal paramter by its numeric index.
abstract FormalParameter getFormalParameter(String name)
Retrives a specific formal parameter by its name.

Public Methods

public abstract boolean containsFormalParameter (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

public abstract int getCount ()

Returns the number of formal parameters in the collection.

Returns
  • formal parameters contained in the collection.
See Also

public abstract FormalParameter getFormalParameter (int index)

Retrieves a specific formal paramter by its numeric index.

Parameters
index the index of the object in collection.
Returns
Throws
IndexOutOfBoundsException thrown if the index is invalid.

public abstract FormalParameter getFormalParameter (String name)

Retrives a specific formal parameter by its name.

Parameters
name the name of the FormalParameter object.
Returns
Throws
IllegalArgumentException thrown if no formal parameter has the given name.