public interface

ActualParameters

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

Class Overview

The ActualParameters interface provides a read-write collection of actual parameter objects.

Summary

Public Methods
abstract void clear()
Clears the actual parameters collection.
abstract ActualParameter getActualParameter(int index)
Retrieves a specific actual parameter at a given index in the collection.
abstract ActualParameter getActualParameter(String name)
Retrieves the actual parameter with the given name.
abstract ActualParameter getActualParameter(FormalParameter formalParam)
Retrieves the actual parameter associated with the given formal parameter.
abstract Enumeration getActualParameters(String name)
This method is deprecated. The name of the actual parameter is now used as the key therefore this enumeration will return at most one value, the same as getActualParameter(String).
abstract Enumeration getActualParameters(FormalParameter formalParam)
Returns an array of ActualParameter objects which matches the specified FormalParameter.
abstract int getCount()
Returns the number of actual parameters in the collection.
abstract int getNumMismatchedParams()
Returns the number of actual parameters, whose name doesn't match a formal parameter.
abstract boolean hasActualParameter(FormalParameter formalParameter)
Determines whether an actual parameter exists for a given formal parameter.
abstract ActualParameter newActualParameter(String name)
Creates a new ActualParameter object with the given name, and it adds it to the collection.
abstract ActualParameter newActualParameter(FormalParameter formalParam)
Creates a new ActualParameter object associated with the given formal parameter.
abstract void remove(int index)
Removes the ActualParameter object with the given index from the collection.
abstract void remove(String name)
Removes the ActualParameter object with the given name.
abstract void remove(FormalParameter formalParam)
Removes the ActualParameter object associated with the given formal parameter.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract void clear ()

Clears the actual parameters collection.

public abstract ActualParameter getActualParameter (int index)

Retrieves a specific actual parameter at a given index in the collection.

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

public abstract ActualParameter getActualParameter (String name)

Retrieves the actual parameter with the given name.

Parameters
name the name of the actual parameter.
Returns
Throws
IllegalArgumentException thrown if no actual parameter has the given name.

public abstract ActualParameter getActualParameter (FormalParameter formalParam)

Retrieves the actual parameter associated with the given formal parameter.

Parameters
formalParam the FormalParameter associated with the actual parameter.
Returns
Throws
IllegalArgumentException thrown if no actual parameter is associated with the given formal parameter object.

public abstract Enumeration getActualParameters (String name)

This method is deprecated.
The name of the actual parameter is now used as the key therefore this enumeration will return at most one value, the same as getActualParameter(String).

Returns an enumeration of ActualParameter objects with the specified actual parameter name.

Parameters
name the actual parameter name
Returns
  • an enumeration over the ActualParameter objects with the specified name
Throws
IllegalArgumentException thrown if the name does not exist

public abstract Enumeration getActualParameters (FormalParameter formalParam)

Returns an array of ActualParameter objects which matches the specified FormalParameter.

Parameters
formalParam a FormalParameter
Returns
  • an enumeration over the ActualParameter objects matching the specified FormalParameter.
Throws
IllegalArgumentException if there is no such an ActualParameter matching the specified FormalParameter.

public abstract int getCount ()

Returns the number of actual parameters in the collection.

Returns
  • the actual parameters contained in the collection.
See Also

public abstract int getNumMismatchedParams ()

Returns the number of actual parameters, whose name doesn't match a formal parameter.

Returns
  • number of mismatched parameters in the collection.

public abstract boolean hasActualParameter (FormalParameter formalParameter)

Determines whether an actual parameter exists for a given formal parameter.

Parameters
formalParameter The FormalParameter who's actual you are looking for.
Returns
  • True if an actual value exists for this formal parameter; false, otherwise.

public abstract ActualParameter newActualParameter (String name)

Creates a new ActualParameter object with the given name, and it adds it to the collection.

Parameters
name the name of the new ActualParameter object.
Returns
  • the ActualParameter object created.
Throws
IllegalArgumentException thrown if the name is null.

public abstract ActualParameter newActualParameter (FormalParameter formalParam)

Creates a new ActualParameter object associated with the given formal parameter.

Parameters
formalParam the FormalParameter object the caller wants to associate the actual parameter with.
Returns
Throws
IllegalArgumentException

public abstract void remove (int index)

Removes the ActualParameter object with the given index from the collection.

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

public abstract void remove (String name)

Removes the ActualParameter object with the given name.

Parameters
name the name of the ActualParameter object.
Throws
IllegalArgumentException thrown if no actual parameter has the given name.

public abstract void remove (FormalParameter formalParam)

Removes the ActualParameter object associated with the given formal parameter.

Parameters
formalParam the FormalParameter associated with the actual parameter.
Throws
IllegalArgumentException thrown if no actual parameter is associated with the given formal parameter object.