FlowPDF::StepResult

This class provides methods to provide various output results of a step in different runtime contexts.

setJobStepOutcome($jobStepOutcome)

Sets a job step outcome. Could be warning, success or an error.

Parameters

(Required)(String) desired procedure/task outcome. Could be one of: warning, success, error.

Returns

(FlowPDF::StepResult) self

Usage

$stepResult->setJobStepOutcome('warning');▼

setPipelineSummary($pipelineSummaryName, $pipelineSummaryText)

Sets the summary of the current pipeline task.

Parameters

(Required)(String) Pipeline Summary Property Text
(Required)(String) Pipeline Summary Value.

Returns

(FlowPDF::StepResult) self

Usage

$stepResult->setPipelineSummary('Procedure Execution Result:', 'All tests are ok');▼

setJobStepSummary($jobStepSummary)

Sets the summary of the current job step.

Parameters

(Required)(String) Job Step Summary

Returns

(FlowPDF::StepResult) self

Usage

$stepResult->setJobStepSummary('All tests are ok in this step.');▼

setJobSummary($jobSummary)

Sets the summary of the current job.

Parameters

(Required)(String) Job Summary

Returns

(FlowPDF::StepResult) self

Usage

$stepResult->setJobSummary('All tests are ok');▼

setOutcomeProperty($propertyPath, $propertyValue)

Sets the outcome property.

Parameters

(Required)(String) Property Path
(Required)(String) Value of property to be set

Returns

(FlowPDF::StepResult) self

$stepResult->setOutcomeProperty('/myJob/buildNumber', '42');▼

setOutputParameter($parameterName, $parameterValue)

Sets an output parameter for a job.

Parameters

(Required)(String) Output parameter name
(Required)(String) Output parameter value

Returns

(FlowPDF::StepResult) self

$stepResult->setOutputParameter('Last Build Number', '42');▼

setReportUrl($reportName, $reportUrl)

Sets a report name and its URL for the job. If it is being invoked in pipeline runs, it also sets a property which is in turn used to show the link in pipeline summary.

Parameters

(Required)(String) Report name
(Required)(String) Report URL

Returns

(FlowPDF::StepResult) self

$stepResult->setReportUrl('Build Link #42', 'http://localhost:8080/job/HelloWorld/42');▼

apply()

Applies scheduled changes without schedule cleanup in queue order: first scheduled, first executed.

Parameters

None

Returns

(FlowPDF::StepResult) self

Usage

$stepResult->apply();▼

flush()

Flushes scheduled actions.

Parameters

None

Returns

(FlowPDF::StepResult) self

Usage

$stepResult->flush();▼

applyAndFlush()

Executes the schedule queue and flushes it then.

Parameters

None

Returns

(FlowPDF::StepResult) self

Usage

$stepResult->applyAndFlush();▼