Class QFrontendStepMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.processes.QStepMetaData

com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendStepMetaData

All Implemented Interfaces:

QMetaDataObject, Serializable

public class QFrontendStepMetaData
extends QStepMetaData

Meta-Data to define a front-end step in a process in a QQQ instance (e.g., a screen presented to a user).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
QFrontendStepMetaData()

Method Summary

Modifier and Type	Method	Description
void	addFormField(QFieldMetaData fieldMetaData)	adder for formFields
String	getBackStepName()	Getter for backStepName
List<QFrontendComponentMetaData>	getComponents()	Getter for components
String	getFormat()	Getter for format
QFieldMetaData	getFormField(String fieldName)	Getter for a single formFields by its name
List<QFieldMetaData>	getFormFields()	Getter for formFields
List<QHelpContent>	getHelpContents()	Getter for helpContents
List<QFieldMetaData>	getInputFields()	Get a list of all of the input fields used by this function
List<QFieldMetaData>	getRecordListFields()	Getter for recordListFields
List<QFieldMetaData>	getViewFields()	Getter for viewFields
void	removeHelpContent(Set<HelpRole> roles)	remove a single helpContent based on its set of roles
void	setBackStepName(String backStepName)	Setter for backStepName
void	setComponents(List<QFrontendComponentMetaData> components)	Setter for components
void	setFormat(String format)	Setter for format
void	setFormFields(List<QFieldMetaData> formFields)	Setter for formFields
void	setHelpContents(List<QHelpContent> helpContents)	Setter for helpContents
void	setRecordListFields(List<QFieldMetaData> recordListFields)	Setter for recordListFields
void	setViewFields(List<QFieldMetaData> viewFields)	Setter for viewFields
QFrontendStepMetaData	withBackStepName(String backStepName)	Fluent setter for backStepName
QFrontendStepMetaData	withComponent(QFrontendComponentMetaData component)	Fluent setter for adding 1 component
QFrontendStepMetaData	withComponents(List<QFrontendComponentMetaData> components)	Fluent setter for components
QFrontendStepMetaData	withFormat(String format)	Fluent setter for format
QFrontendStepMetaData	withFormField(QFieldMetaData formField)	fluent setter to add a single form field
QFrontendStepMetaData	withFormFields(List<QFieldMetaData> formFields)	fluent setter for formFields
QFrontendStepMetaData	withHelpContent(QHelpContent helpContent)	Fluent setter for adding 1 helpContent
QFrontendStepMetaData	withHelpContents(List<QHelpContent> helpContents)	Fluent setter for helpContents
QFrontendStepMetaData	withLabel(String label)	fluent setter for label
QFrontendStepMetaData	withName(String name)	fluent setter for name
QFrontendStepMetaData	withRecordListField(QFieldMetaData recordListField)	fluent setter to add a single recordList field
QFrontendStepMetaData	withRecordListFields(List<QFieldMetaData> recordListFields)	fluent setter for recordListFields
QFrontendStepMetaData	withViewField(QFieldMetaData viewField)	fluent setter to add a single view field
QFrontendStepMetaData	withViewFields(List<QFieldMetaData> viewFields)	fluent setter for viewFields

Methods inherited from class com.kingsrook.qqq.backend.core.model.metadata.processes.QStepMetaData

getLabel, getName, getOutputFields, getStepType, setLabel, setName, setStepType

Methods inherited from class java.lang.Object

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

Constructor Details

QFrontendStepMetaData

public QFrontendStepMetaData()

Method Details

getComponents

public List<QFrontendComponentMetaData> getComponents()

Getter for components

setComponents

public void setComponents(List<QFrontendComponentMetaData> components)

Setter for components

withComponent

public QFrontendStepMetaData withComponent(QFrontendComponentMetaData component)

Fluent setter for adding 1 component

withComponents

public QFrontendStepMetaData withComponents(List<QFrontendComponentMetaData> components)

Fluent setter for components

getFormField

public QFieldMetaData getFormField(String fieldName)

Getter for a single formFields by its name

getFormFields

public List<QFieldMetaData> getFormFields()

Getter for formFields

addFormField

public void addFormField(QFieldMetaData fieldMetaData)

adder for formFields

setFormFields

public void setFormFields(List<QFieldMetaData> formFields)

Setter for formFields

withFormField

public QFrontendStepMetaData withFormField(QFieldMetaData formField)

fluent setter to add a single form field

withFormFields

public QFrontendStepMetaData withFormFields(List<QFieldMetaData> formFields)

fluent setter for formFields

getViewFields

public List<QFieldMetaData> getViewFields()

Getter for viewFields

setViewFields

public void setViewFields(List<QFieldMetaData> viewFields)

Setter for viewFields

withViewField

public QFrontendStepMetaData withViewField(QFieldMetaData viewField)

fluent setter to add a single view field

withViewFields

public QFrontendStepMetaData withViewFields(List<QFieldMetaData> viewFields)

fluent setter for viewFields

getRecordListFields

public List<QFieldMetaData> getRecordListFields()

Getter for recordListFields

setRecordListFields

public void setRecordListFields(List<QFieldMetaData> recordListFields)

Setter for recordListFields

withRecordListField

public QFrontendStepMetaData withRecordListField(QFieldMetaData recordListField)

fluent setter to add a single recordList field

withRecordListFields

public QFrontendStepMetaData withRecordListFields(List<QFieldMetaData> recordListFields)

fluent setter for recordListFields

withName

public QFrontendStepMetaData withName(String name)

fluent setter for name

Overrides:

withName in class QStepMetaData

withLabel

public QFrontendStepMetaData withLabel(String label)

fluent setter for label

Overrides:

withLabel in class QStepMetaData

getInputFields

public List<QFieldMetaData> getInputFields()

Get a list of all of the input fields used by this function

Overrides:

getInputFields in class QStepMetaData

getHelpContents

public List<QHelpContent> getHelpContents()

Getter for helpContents

setHelpContents

public void setHelpContents(List<QHelpContent> helpContents)

Setter for helpContents

withHelpContents

public QFrontendStepMetaData withHelpContents(List<QHelpContent> helpContents)

Fluent setter for helpContents

withHelpContent

public QFrontendStepMetaData withHelpContent(QHelpContent helpContent)

Fluent setter for adding 1 helpContent

removeHelpContent

public void removeHelpContent(Set<HelpRole> roles)

remove a single helpContent based on its set of roles

getFormat

public String getFormat()

Getter for format

setFormat

public void setFormat(String format)

Setter for format

withFormat

public QFrontendStepMetaData withFormat(String format)

Fluent setter for format

getBackStepName

public String getBackStepName()

Getter for backStepName

setBackStepName

public void setBackStepName(String backStepName)

Setter for backStepName

withBackStepName

public QFrontendStepMetaData withBackStepName(String backStepName)

Fluent setter for backStepName