Class QProcessMetaData

java.lang.Object

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

All Implemented Interfaces:

QAppChildMetaData, MetaDataProducerOutput, MetaDataWithName, MetaDataWithPermissionRules, SourceQBitAware, QMetaDataObject, TopLevelMetaDataInterface, Serializable

public class QProcessMetaData
extends Object
implements QAppChildMetaData, MetaDataWithPermissionRules, TopLevelMetaDataInterface, SourceQBitAware

Meta-Data to define a process in a QQQ instance.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
QProcessMetaData()

Method Summary

Modifier and Type	Method	Description
QProcessMetaData	addOptionalStep(QStepMetaData step)	Deprecated.
void	addSelfToInstance(QInstance qInstance)	call the appropriate methods on a QInstance to add ourselves to it.
QProcessMetaData	addStep(int index, QStepMetaData step)	Deprecated.
QProcessMetaData	addStep(QStepMetaData step)	Deprecated.
Map<String,QStepMetaData>	getAllSteps()	Getter for the full map of all steps (not the step list!)
QBackendStepMetaData	getBackendStep(String name)	Wrapper to getStep, that internally casts to BackendStepMetaData
BasepullConfiguration	getBasepullConfiguration()	Getter for basepullConfiguration
QBackendStepMetaData	getCancelStep()	Getter for cancelStep
QFrontendStepMetaData	getFrontendStep(String name)	Wrapper to getStep, that internally casts to FrontendStepMetaData
QIcon	getIcon()	Getter for icon
Optional<QFieldMetaData>	getInputField(String name)	Get the (optional, first) input field on this process with the given name.
List<QFieldMetaData>	getInputFields()	Get a list of all the *unique* input fields used by all the steps in this process.
boolean	getIsHidden()	Getter for isHidden
String	getLabel()	Getter for label
Integer	getMaxInputRecords()	Getter for maxInputRecords
Integer	getMinInputRecords()	Getter for minInputRecords
String	getName()	Getter for name
List<QFieldMetaData>	getOutputFields()	Get a list of all the *unique* output fields used by all the steps in this process.
QPermissionRules	getPermissionRules()	Getter for permissionRules
QCodeReference	getProcessTracerCodeReference()	Getter for processTracerCodeReference
QScheduleMetaData	getSchedule()	Getter for schedule
String	getSourceQBitName()	Getter for sourceQBitName
QStepMetaData	getStep(String stepName)
ProcessStepFlow	getStepFlow()	Getter for stepFlow
List<QStepMetaData>	getStepList()	Getter for stepList
Map<String,QSupplementalProcessMetaData>	getSupplementalMetaData()	Getter for supplementalMetaData
QSupplementalProcessMetaData	getSupplementalMetaData(String type)	Getter for supplementalMetaData
String	getTableName()	Getter for tableName
String	getVariantBackend()	Getter for variantBackend
VariantRunStrategy	getVariantRunStrategy()	Getter for variantRunStrategy
void	setBasepullConfiguration(BasepullConfiguration basepullConfiguration)	Setter for basepullConfiguration
void	setCancelStep(QBackendStepMetaData cancelStep)	Setter for cancelStep
void	setIcon(QIcon icon)	Setter for icon
void	setIsHidden(boolean isHidden)	Setter for isHidden
void	setLabel(String label)	Setter for label
void	setMaxInputRecords(Integer maxInputRecords)	Setter for maxInputRecords
void	setMinInputRecords(Integer minInputRecords)	Setter for minInputRecords
void	setName(String name)	Setter for name
void	setPermissionRules(QPermissionRules permissionRules)	Setter for permissionRules
void	setProcessTracerCodeReference(QCodeReference processTracerCodeReference)	Setter for processTracerCodeReference
void	setSchedule(QScheduleMetaData schedule)	Setter for schedule
void	setSourceQBitName(String sourceQBitName)	Setter for sourceQBitName
void	setStepFlow(ProcessStepFlow stepFlow)	Setter for stepFlow
void	setStepList(List<QStepMetaData> stepList)	Setter for stepList - note - calling this method ALSO overwrites the steps map!
void	setSupplementalMetaData(Map<String,QSupplementalProcessMetaData> supplementalMetaData)	Setter for supplementalMetaData
void	setTableName(String tableName)	Setter for tableName
void	setVariantBackend(String variantBackend)	Setter for variantBackend
void	setVariantRunStrategy(VariantRunStrategy variantRunStrategy)	Setter for variantRunStrategy
String	toString()
QProcessMetaData	withBasepullConfiguration(BasepullConfiguration basepullConfiguration)	Fluent setter for basepullConfiguration
QProcessMetaData	withCancelStep(QBackendStepMetaData cancelStep)	Fluent setter for cancelStep
QProcessMetaData	withIcon(QIcon icon)	Fluent setter for icon
QProcessMetaData	withIsHidden(boolean isHidden)	Fluent Setter for isHidden
QProcessMetaData	withLabel(String label)	Setter for label
QProcessMetaData	withMaxInputRecords(Integer maxInputRecords)	Fluent setter for maxInputRecords
QProcessMetaData	withMinInputRecords(Integer minInputRecords)	Fluent setter for minInputRecords
QProcessMetaData	withName(String name)	Setter for name
QProcessMetaData	withOptionalStep(QStepMetaData step)	add a step ONLY to the step map - NOT the list w/ default execution order.
QProcessMetaData	withPermissionRules(QPermissionRules permissionRules)	Fluent setter for permissionRules
QProcessMetaData	withProcessTracerCodeReference(QCodeReference processTracerCodeReference)	Fluent setter for processTracerCodeReference
QProcessMetaData	withSchedule(QScheduleMetaData schedule)	Fluent setter for schedule
QProcessMetaData	withSourceQBitName(String sourceQBitName)	Fluent setter for sourceQBitName
QProcessMetaData	withStep(int index, QStepMetaData step)	add a step to the stepList (at the specified index) and the step map
QProcessMetaData	withStep(QStepMetaData step)
QProcessMetaData	withStepFlow(ProcessStepFlow stepFlow)	Fluent setter for stepFlow
QProcessMetaData	withStepList(List<QStepMetaData> stepList)	Setter for stepList
QProcessMetaData	withSupplementalMetaData(QSupplementalProcessMetaData supplementalMetaData)	Fluent setter for supplementalMetaData
QProcessMetaData	withSupplementalMetaData(Map<String,QSupplementalProcessMetaData> supplementalMetaData)	Fluent setter for supplementalMetaData
QProcessMetaData	withTableName(String tableName)	Setter for tableName
QProcessMetaData	withVariantBackend(String variantBackend)	Fluent setter for variantBackend
QProcessMetaData	withVariantRunStrategy(VariantRunStrategy variantRunStrategy)	Fluent setter for variantRunStrategy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.model.metadata.qbits.SourceQBitAware

getSourceQBit, getSourceQBitConfig

Constructor Details

QProcessMetaData

public QProcessMetaData()

Method Details

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Getter for name

Specified by:

getName in interface MetaDataWithName

Specified by:

getName in interface QAppChildMetaData

Specified by:

getName in interface TopLevelMetaDataInterface

setName

public void setName(String name)

Setter for name

Specified by:

setName in interface MetaDataWithName

withName

public QProcessMetaData withName(String name)

Setter for name

getLabel

public String getLabel()

Getter for label

Specified by:

getLabel in interface MetaDataWithName

Specified by:

getLabel in interface QAppChildMetaData

setLabel

public void setLabel(String label)

Setter for label

Specified by:

setLabel in interface MetaDataWithName

withLabel

public QProcessMetaData withLabel(String label)

Setter for label

getTableName

public String getTableName()

Getter for tableName

setTableName

public void setTableName(String tableName)

Setter for tableName

withTableName

public QProcessMetaData withTableName(String tableName)

Setter for tableName

getStepList

public List<QStepMetaData> getStepList()

Getter for stepList

withStepList

public QProcessMetaData withStepList(List<QStepMetaData> stepList)

Setter for stepList

withStep

public QProcessMetaData withStep(QStepMetaData step)

addStep

@Deprecated(since="withStep was added")
public QProcessMetaData addStep(QStepMetaData step)

Deprecated.

add a step to the stepList and map

withStep

public QProcessMetaData withStep(int index,
 QStepMetaData step)

add a step to the stepList (at the specified index) and the step map

addStep

@Deprecated(since="withStep was added")
public QProcessMetaData addStep(int index,
 QStepMetaData step)

Deprecated.

add a step to the stepList (at the specified index) and the step map

withOptionalStep

public QProcessMetaData withOptionalStep(QStepMetaData step)

add a step ONLY to the step map - NOT the list w/ default execution order.

addOptionalStep

@Deprecated(since="withOptionalStep was added")
public QProcessMetaData addOptionalStep(QStepMetaData step)

Deprecated.

add a step ONLY to the step map - NOT the list w/ default execution order.

setStepList

public void setStepList(List<QStepMetaData> stepList)

Setter for stepList - note - calling this method ALSO overwrites the steps map!

getStep

public QStepMetaData getStep(String stepName)

getBackendStep

public QBackendStepMetaData getBackendStep(String name)

Wrapper to getStep, that internally casts to BackendStepMetaData

getFrontendStep

public QFrontendStepMetaData getFrontendStep(String name)

Wrapper to getStep, that internally casts to FrontendStepMetaData

getInputFields

public List<QFieldMetaData> getInputFields()

Get a list of all the *unique* input fields used by all the steps in this process.

getInputField

public Optional<QFieldMetaData> getInputField(String name)

Get the (optional, first) input field on this process with the given name.

Parameters:

name - name of the field to be returned

Returns:

the first input field found in the process's steps that has that name, or empty if none are found (where first is based on: the order of steps in the stepList, then any optional steps, in the order in which they come out of the step map (which internally is always built as LinkedHashMap, so it preserves insertion order - but - if the caller supplied their own map, then results could potentially get into undefined behavior!)

getOutputFields

public List<QFieldMetaData> getOutputFields()

Get a list of all the *unique* output fields used by all the steps in this process.

getIsHidden

public boolean getIsHidden()

Getter for isHidden

setIsHidden

public void setIsHidden(boolean isHidden)

Setter for isHidden

withIsHidden

public QProcessMetaData withIsHidden(boolean isHidden)

Fluent Setter for isHidden

getIcon

public QIcon getIcon()

Getter for icon

Specified by:

getIcon in interface QAppChildMetaData

setIcon

public void setIcon(QIcon icon)

Setter for icon

withIcon

public QProcessMetaData withIcon(QIcon icon)

Fluent setter for icon

getSchedule

public QScheduleMetaData getSchedule()

Getter for schedule

setSchedule

public void setSchedule(QScheduleMetaData schedule)

Setter for schedule

withSchedule

public QProcessMetaData withSchedule(QScheduleMetaData schedule)

Fluent setter for schedule

getBasepullConfiguration

public BasepullConfiguration getBasepullConfiguration()

Getter for basepullConfiguration

setBasepullConfiguration

public void setBasepullConfiguration(BasepullConfiguration basepullConfiguration)

Setter for basepullConfiguration

withBasepullConfiguration

public QProcessMetaData withBasepullConfiguration(BasepullConfiguration basepullConfiguration)

Fluent setter for basepullConfiguration

getPermissionRules

public QPermissionRules getPermissionRules()

Getter for permissionRules

Specified by:

getPermissionRules in interface MetaDataWithPermissionRules

setPermissionRules

public void setPermissionRules(QPermissionRules permissionRules)

Setter for permissionRules

Specified by:

setPermissionRules in interface MetaDataWithPermissionRules

withPermissionRules

public QProcessMetaData withPermissionRules(QPermissionRules permissionRules)

Fluent setter for permissionRules

addSelfToInstance

public void addSelfToInstance(QInstance qInstance)

Description copied from interface: MetaDataProducerOutput

call the appropriate methods on a QInstance to add ourselves to it.

Specified by:

addSelfToInstance in interface MetaDataProducerOutput

Specified by:

addSelfToInstance in interface TopLevelMetaDataInterface

getSupplementalMetaData

public Map<String,QSupplementalProcessMetaData> getSupplementalMetaData()

Getter for supplementalMetaData

getSupplementalMetaData

public QSupplementalProcessMetaData getSupplementalMetaData(String type)

Getter for supplementalMetaData

setSupplementalMetaData

public void setSupplementalMetaData(Map<String,QSupplementalProcessMetaData> supplementalMetaData)

Setter for supplementalMetaData

withSupplementalMetaData

public QProcessMetaData withSupplementalMetaData(Map<String,QSupplementalProcessMetaData> supplementalMetaData)

Fluent setter for supplementalMetaData

withSupplementalMetaData

public QProcessMetaData withSupplementalMetaData(QSupplementalProcessMetaData supplementalMetaData)

Fluent setter for supplementalMetaData

getMinInputRecords

public Integer getMinInputRecords()

Getter for minInputRecords

setMinInputRecords

public void setMinInputRecords(Integer minInputRecords)

Setter for minInputRecords

withMinInputRecords

public QProcessMetaData withMinInputRecords(Integer minInputRecords)

Fluent setter for minInputRecords

getMaxInputRecords

public Integer getMaxInputRecords()

Getter for maxInputRecords

setMaxInputRecords

public void setMaxInputRecords(Integer maxInputRecords)

Setter for maxInputRecords

withMaxInputRecords

public QProcessMetaData withMaxInputRecords(Integer maxInputRecords)

Fluent setter for maxInputRecords

getVariantRunStrategy

public VariantRunStrategy getVariantRunStrategy()

Getter for variantRunStrategy

setVariantRunStrategy

public void setVariantRunStrategy(VariantRunStrategy variantRunStrategy)

Setter for variantRunStrategy

withVariantRunStrategy

public QProcessMetaData withVariantRunStrategy(VariantRunStrategy variantRunStrategy)

Fluent setter for variantRunStrategy

getVariantBackend

public String getVariantBackend()

Getter for variantBackend

setVariantBackend

public void setVariantBackend(String variantBackend)

Setter for variantBackend

withVariantBackend

public QProcessMetaData withVariantBackend(String variantBackend)

Fluent setter for variantBackend

getAllSteps

public Map<String,QStepMetaData> getAllSteps()

Getter for the full map of all steps (not the step list!)

getCancelStep

public QBackendStepMetaData getCancelStep()

Getter for cancelStep

setCancelStep

public void setCancelStep(QBackendStepMetaData cancelStep)

Setter for cancelStep

withCancelStep

public QProcessMetaData withCancelStep(QBackendStepMetaData cancelStep)

Fluent setter for cancelStep

getStepFlow

public ProcessStepFlow getStepFlow()

Getter for stepFlow

setStepFlow

public void setStepFlow(ProcessStepFlow stepFlow)

Setter for stepFlow

withStepFlow

public QProcessMetaData withStepFlow(ProcessStepFlow stepFlow)

Fluent setter for stepFlow

getProcessTracerCodeReference

public QCodeReference getProcessTracerCodeReference()

Getter for processTracerCodeReference

setProcessTracerCodeReference

public void setProcessTracerCodeReference(QCodeReference processTracerCodeReference)

Setter for processTracerCodeReference

withProcessTracerCodeReference

public QProcessMetaData withProcessTracerCodeReference(QCodeReference processTracerCodeReference)

Fluent setter for processTracerCodeReference

getSourceQBitName

public String getSourceQBitName()

Getter for sourceQBitName

Specified by:

getSourceQBitName in interface SourceQBitAware

setSourceQBitName

public void setSourceQBitName(String sourceQBitName)

Setter for sourceQBitName

Specified by:

setSourceQBitName in interface SourceQBitAware

withSourceQBitName

public QProcessMetaData withSourceQBitName(String sourceQBitName)

Fluent setter for sourceQBitName

Specified by:

withSourceQBitName in interface SourceQBitAware