java.lang.Object | |
↳ | com.microstrategy.web.transform.FormalParameterImpl |
FormalParameterImpl implements the FormalParameter interface and defines the structure of a single formal parameter.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
protected String | name |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
FormalParameterImpl(String name, int type)
Constructor of FormalparameterImpl class.
| |||||||||||
FormalParameterImpl(String name, int type, FormalParameterAnnotation annotation) |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
void |
checkValue(Object value)
Verifies that the value correspons to the type of the FormalParameter object.
| ||||||||||
FormalParameterAnnotation | getAnnotation() | ||||||||||
Object |
getDefaultValue()
Returns the default value of the FormalParameter object.
| ||||||||||
String |
getDescription()
Returns the textual description of the FormalParameter object
| ||||||||||
String |
getName()
Returns the name of the FormalParameter object.
| ||||||||||
String | getStringKey() | ||||||||||
int |
getType()
Returns the data type of the FormalParameter object.
| ||||||||||
Object |
getValue()
Returns the actual value of the FormalParameter object.
| ||||||||||
Object |
getValue(boolean returnDefault)
Returns the actual value of the FormalParameter object.
| ||||||||||
boolean |
isRequired()
Returns whether the FormalParameter object is required by the transform.
| ||||||||||
String |
paramTypeToString(int paramType)
Returns the type of the FormalParamber object as string.
| ||||||||||
void | setAnnotation(FormalParameterAnnotation annotation) | ||||||||||
void |
setDefaultValue(Object defaultValue)
Sets the default value of the FormalParameter object.
| ||||||||||
void |
setDescription(String description)
Sets the description of the FormalParameter object.
| ||||||||||
void |
setRequired(boolean required)
Sets the FormalParameter object as required.
| ||||||||||
void |
setValue(Object value)
Sets the actual value of the FormalParameter object.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Constructor of FormalparameterImpl class.
name | the name of the FormalParameter object. |
---|---|
type | the type of the FormalParameter object. |
Verifies that the value correspons to the type of the FormalParameter object.
value | the value wanted to be checked. |
---|
IllegalArgumentException | thrown if the default value is null or does not correspond to the data type of the FormalParameter object. |
---|
Returns the default value of the FormalParameter object.
Returns the textual description of the FormalParameter object
Returns the name of the FormalParameter object.
Returns the data type of the FormalParameter object.
Returns the actual value of the FormalParameter object. If the actual value is null, then it will return the default value.
Returns the actual value of the FormalParameter object. If it is null and the parameter is set to True, then it will return the default value.
returnDefault | specifies whether it will return the default value in case the actual value is null. |
---|
Returns whether the FormalParameter object is required by the transform.
Returns the type of the FormalParamber object as string.
paramType | the type of the FormalParameter object. |
---|
Sets the default value of the FormalParameter object.
defaultValue | the default value of the FormalParameter object. |
---|
IllegalArgumentException | thrown if the default value is null or does not correspond to the data type of the FormalParameter object. |
---|
Sets the description of the FormalParameter object.
description | the description of the FromalParameter object. |
---|
Sets the FormalParameter object as required.
required | whether you want to set the FormalParameter as required or not. |
---|
Sets the actual value of the FormalParameter object.
value | the actual value of the FormalParameter ojbect. |
---|
IllegalArgumentException | thrown if the actual value is null or does not correspond to the data type of the FormalParameter object. |
---|