Class WorkflowDescriptionSection

java.lang.Object

com.scivicslab.actoriac.report.sections.basic.WorkflowDescriptionSection

All Implemented Interfaces:

SectionBuilder

public class WorkflowDescriptionSection
extends Object
implements SectionBuilder

POJO section builder that outputs the workflow description.

Pure business logic - no CallableByActionName. Use WorkflowDescriptionSectionIIAR to expose as an actor.

Output example:

[Description]
  Main workflow to collect Kubernetes cluster status.
  This workflow gathers node, namespace, and pod information.

Since:

2.16.0

Author:

devteam@scivicslab.com

Field Summary

Fields

Modifier and Type	Field	Description
private String	description

Constructor Summary

Constructors

Constructor	Description
WorkflowDescriptionSection()

Method Summary

Modifier and Type	Method	Description
String	generate()	Generates the section content.
String	getTitle()	Returns the section title.
void	setDescription(String description)	Sets the workflow description.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

description

private String description

Constructor Details

WorkflowDescriptionSection

public WorkflowDescriptionSection()

Method Details

setDescription

public void setDescription(String description)

Sets the workflow description.

Parameters:

description - the workflow description from YAML

generate

public String generate()

Description copied from interface: SectionBuilder

Generates the section content.

Specified by:

generate in interface SectionBuilder

Returns:

the section content as a string

getTitle

public String getTitle()

Description copied from interface: SectionBuilder

Returns the section title.

If null or empty, the section content is output without a title line.

Specified by:

getTitle in interface SectionBuilder

Returns:

the section title, or null for no title