public interface

FormalParameter

com.microstrategy.web.transform.FormalParameter
Known Indirect Subclasses

Class Overview

The FormalParameter interface defines the structure of a single formal parameter.

Summary

Constants
int PARAM_TYPE_BOOLEAN Specifies that the formal parameter type is boolean.
int PARAM_TYPE_FLOAT Specifies that the formal parameter type is float.
int PARAM_TYPE_INTEGER Specifies that the formal parameter type is integer.
int PARAM_TYPE_STRING Specifies that the formal parameter type is string.
int PARAM_TYPE_UNKNOWN Specifies that the formal parameter type is unkown.
Public Methods
abstract void checkValue(Object value)
Checks if the value corresponds to the type of the formal parameter.
abstract Object getDefaultValue()
Returns the default value used in the abscence of an explicit value.
abstract String getDescription()
Returns the description of the FormalParameter object.
abstract String getName()
Returns the FormalParameter object name.
abstract int getType()
Returns the value type of the FormalParameter object.
abstract Object getValue()
Returns the actual value of the FormalParameter object..
abstract boolean isRequired()
Indicates if a parameter value is required for the execution of the transform.
abstract String paramTypeToString(int paramType)
Returns the value type converted into a string form.
abstract void setValue(Object value)
Sets an actual value of a formal parameter.

Constants

public static final int PARAM_TYPE_BOOLEAN

Specifies that the formal parameter type is boolean.

Constant Value: 4 (0x00000004)

public static final int PARAM_TYPE_FLOAT

Specifies that the formal parameter type is float.

Constant Value: 3 (0x00000003)

public static final int PARAM_TYPE_INTEGER

Specifies that the formal parameter type is integer.

Constant Value: 2 (0x00000002)

public static final int PARAM_TYPE_STRING

Specifies that the formal parameter type is string.

Constant Value: 1 (0x00000001)

public static final int PARAM_TYPE_UNKNOWN

Specifies that the formal parameter type is unkown.

Constant Value: 0 (0x00000000)

Public Methods

public abstract void checkValue (Object value)

Checks if the value corresponds to the type of the formal parameter.

Parameters
value the value wanted to be checked.
Throws
IllegalArgumentException thrown if the value supplied is malformed.

public abstract Object getDefaultValue ()

Returns the default value used in the abscence of an explicit value.

Returns
  • default value of the formal parameter.

public abstract String getDescription ()

Returns the description of the FormalParameter object.

Returns
  • description of the FormalParameter object.

public abstract String getName ()

Returns the FormalParameter object name.

Returns
  • the FormalParameter object name.

public abstract int getType ()

Returns the value type of the FormalParameter object.

Returns
  • value type of the FormalParameter object.

public abstract Object getValue ()

Returns the actual value of the FormalParameter object..

Returns
  • value of the FormalParameter object.

public abstract boolean isRequired ()

Indicates if a parameter value is required for the execution of the transform.

Returns
  • whether the transform requires a specific parameter value.

public abstract 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.

public abstract void setValue (Object value)

Sets an actual value of a formal parameter.

Parameters
value the actual value of the FormalParameter
Throws
IllegalArgumentException thrown if the value supplied is malformed.