Package com.microstrategy.web.transform

Interface ActualParameters

All Superinterfaces:

java.lang.Cloneable, ConfigurationElement

All Known Implementing Classes:

ActualParametersImpl

public interface ActualParameters
extends ConfigurationElement

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

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the actual parameters collection.
ActualParameter	getActualParameter(int index)	Retrieves a specific actual parameter at a given index in the collection.
ActualParameter	getActualParameter(FormalParameter formalParam)	Retrieves the actual parameter associated with the given formal parameter.
ActualParameter	getActualParameter(java.lang.String name)	Retrieves the actual parameter with the given name.
java.util.Enumeration	getActualParameters(FormalParameter formalParam)	Returns an array of ActualParameter objects which matches the specified FormalParameter.
java.util.Enumeration	getActualParameters(java.lang.String name)	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).
int	getCount()	Returns the number of actual parameters in the collection.
int	getNumMismatchedParams()	Returns the number of actual parameters, whose name doesn't match a formal parameter.
boolean	hasActualParameter(FormalParameter formalParameter)	Determines whether an actual parameter exists for a given formal parameter.
ActualParameter	newActualParameter(FormalParameter formalParam)	Creates a new ActualParameter object associated with the given formal parameter.
ActualParameter	newActualParameter(java.lang.String name)	Creates a new ActualParameter object with the given name, and it adds it to the collection.
void	remove(int index)	Removes the ActualParameter object with the given index from the collection.
void	remove(FormalParameter formalParam)	Removes the ActualParameter object associated with the given formal parameter.
void	remove(java.lang.String name)	Removes the ActualParameter object with the given name.

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Method Detail

getCount

int getCount()

Returns the number of actual parameters in the collection.

Returns:

the actual parameters contained in the collection.

See Also:

ActualParameter

hasActualParameter

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.

getActualParameter

ActualParameter getActualParameter(int index)
                            throws java.lang.IndexOutOfBoundsException

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

Parameters:

index - of the object in collection.

Returns:

the ActualParameter object in the collection with the given index.

Throws:

java.lang.IndexOutOfBoundsException - thrown if the index is invalid.

getActualParameter

ActualParameter getActualParameter(java.lang.String name)
                            throws java.lang.IllegalArgumentException

Retrieves the actual parameter with the given name.

Parameters:

name - the name of the actual parameter.

Returns:

the ActualParameter object with the given name.

Throws:

java.lang.IllegalArgumentException - thrown if no actual parameter has the given name.

getActualParameter

ActualParameter getActualParameter(FormalParameter formalParam)
                            throws java.lang.IllegalArgumentException

Retrieves the actual parameter associated with the given formal parameter.

Parameters:

formalParam - the FormalParameter associated with the actual parameter.

Returns:

the ActualParameter object associated with the given formal parameter.

Throws:

java.lang.IllegalArgumentException - thrown if no actual parameter is associated with the given formal parameter object.

getNumMismatchedParams

int getNumMismatchedParams()

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

Returns:

number of mismatched parameters in the collection.

clear

void clear()

Clears the actual parameters collection.

remove

void remove(int index)
     throws java.lang.IndexOutOfBoundsException

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

Parameters:

index - the index of the ActualParameter object in collection.

Throws:

java.lang.IndexOutOfBoundsException - thrown if the index is invalid.

remove

void remove(java.lang.String name)
     throws java.lang.IllegalArgumentException

Removes the ActualParameter object with the given name.

Parameters:

name - the name of the ActualParameter object.

Throws:

java.lang.IllegalArgumentException - thrown if no actual parameter has the given name.

remove

void remove(FormalParameter formalParam)
     throws java.lang.IllegalArgumentException

Removes the ActualParameter object associated with the given formal parameter.

Parameters:

formalParam - the FormalParameter associated with the actual parameter.

Throws:

java.lang.IllegalArgumentException - thrown if no actual parameter is associated with the given formal parameter object.

newActualParameter

ActualParameter newActualParameter(java.lang.String name)
                            throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException - thrown if the name is null.

newActualParameter

ActualParameter newActualParameter(FormalParameter formalParam)
                            throws java.lang.IllegalArgumentException

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:

the ActualParameter object created.

Throws:

java.lang.IllegalArgumentException

getActualParameters

java.util.Enumeration getActualParameters(java.lang.String name)
                                   throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException - thrown if the name does not exist

Since:

MicroStrategy Web 8.0.0

getActualParameters

java.util.Enumeration getActualParameters(FormalParameter formalParam)
                                   throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException - if there is no such an ActualParameter matching the specified FormalParameter.

Since:

MicroStrategy Web 8.0.0