Class DataSourceParameter

  • The DataSourceParameter class allows access to existing data source parameters, but should only be used with data connected to a database.

  • This class provides methods to get the parameter name (getName()), the source cell (getSourceCell()), and the parameter type (getType()).

  • If the parameter type is not DataSourceParameterType.CELL, getSourceCell() will return null.
DataSourceParameter

Access existing data source parameters.

Only use this class with data that's connected to a database.

Methods

MethodReturn typeBrief description
getName()StringGets the parameter name.
getSourceCell()StringGets the source cell the parameter is valued based on, or null if the parameter type is not DataSourceParameterType.CELL.
getType()DataSourceParameterTypeGets the parameter type.

Detailed documentation

getName()

Gets the parameter name.

Return

String — The parameter name.

getSourceCell()

Gets the source cell the parameter is valued based on, or null if the parameter type is not DataSourceParameterType.CELL.

Return

String — The source cell, as specified in A1 notation.

getType()

Gets the parameter type.

Return

DataSourceParameterType — The parameter type.