FlowPDF::Parameter

1 minute read

This class provides methods to process the following two types of parameters that are often used in plugins.

  • Configuration Parameters

  • Procedure Parameters

This is an example usage.

my $parameter = $stepParameters->getParameter('query');
print "Parameter: $parameter\n";

getName()

Retrieves a name from the FlowPDF::Parameter object.

Parameters

None

Returns

(String) Name of the parameter.

Usage

my $parameterName = $parameter->getName();

getValue()

Returns a value of the current parameter.

Parameters

None

Returns

(String) Value of the parameter

Usage

my $parameterValue = $parameter->getValue();

This method gets applied by default, if FlowPDF::Parameter object is used in string context**:

# getValue is being applied automatically in string context. Following 2 lines of code are doing the same:
print "Query: $query\n";
printf "Query: %s\n", $query->getValue();

setName($name)

Sets the name of a parameter.

Parameters

(Required) (String) Parameter Name

Returns

(FlowPDF::Parameter) self

Usage

$parameter->setName('myNewName');

setValue($value)

Sets the value of a parameter.

Parameters

Required)(String) Parameter Value

Returns

(FlowPDF::Parameter) self

Usage

$parameter->setValue('MyNewValue');