Class ApiProcessMetaData

java.lang.Object

com.kingsrook.qqq.api.model.metadata.processes.ApiProcessMetaData

public class ApiProcessMetaData
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiProcessMetaData.AsyncMode

Constructor Summary

Constructors

Constructor	Description
ApiProcessMetaData()

Method Summary

Modifier and Type	Method	Description
void	enrich(QInstanceEnricher qInstanceEnricher, String apiName, QProcessMetaData process)
String	getApiProcessName()	Getter for apiProcessName
APIVersionRange	getApiVersionRange()
ApiProcessMetaData.AsyncMode	getAsyncMode()	Getter for asyncMode
Map<String,QCodeReference>	getCustomizers()	Getter for customizers
String	getDescription()	Getter for description
String	getFinalVersion()	Getter for finalVersion
String	getInitialVersion()	Getter for initialVersion
ApiProcessInput	getInput()	Getter for input
Boolean	getIsExcluded()	Getter for isExcluded
HttpMethod	getMethod()	Getter for method
ApiProcessOutputInterface	getOutput()	Getter for output
Boolean	getOverrideProcessIsHidden()	Getter for overrideProcessIsHidden
String	getPath()	Getter for path
String	getSummary()	Getter for summary
String	getTag()	Getter for tag
void	setApiProcessName(String apiProcessName)	Setter for apiProcessName
void	setAsyncMode(ApiProcessMetaData.AsyncMode asyncMode)	Setter for asyncMode
void	setCustomizers(Map<String,QCodeReference> customizers)	Setter for customizers
void	setDescription(String description)	Setter for description
void	setFinalVersion(String finalVersion)	Setter for finalVersion
void	setInitialVersion(String initialVersion)	Setter for initialVersion
void	setInput(ApiProcessInput input)	Setter for input
void	setIsExcluded(Boolean isExcluded)	Setter for isExcluded
void	setMethod(HttpMethod method)	Setter for method
void	setOutput(ApiProcessOutputInterface output)	Setter for output
void	setOverrideProcessIsHidden(Boolean overrideProcessIsHidden)	Setter for overrideProcessIsHidden
void	setPath(String path)	Setter for path
void	setSummary(String summary)	Setter for summary
void	setTag(String tag)	Setter for tag
void	validate(QInstance qInstance, QProcessMetaData process, QInstanceValidator qInstanceValidator, String apiName)
ApiProcessMetaData	withApiProcessName(String apiProcessName)	Fluent setter for apiProcessName
ApiProcessMetaData	withAsyncMode(ApiProcessMetaData.AsyncMode asyncMode)	Fluent setter for asyncMode
ApiProcessMetaData	withCustomizer(String role, QCodeReference customizer)
ApiProcessMetaData	withCustomizers(Map<String,QCodeReference> customizers)	Fluent setter for customizers
ApiProcessMetaData	withDescription(String description)	Fluent setter for description
ApiProcessMetaData	withFinalVersion(String finalVersion)	Fluent setter for finalVersion
ApiProcessMetaData	withInitialVersion(String initialVersion)	Fluent setter for initialVersion
ApiProcessMetaData	withInput(ApiProcessInput input)	Fluent setter for input
ApiProcessMetaData	withIsExcluded(Boolean isExcluded)	Fluent setter for isExcluded
ApiProcessMetaData	withMethod(HttpMethod method)	Fluent setter for method
ApiProcessMetaData	withOutput(ApiProcessOutputInterface output)	Fluent setter for output
ApiProcessMetaData	withOverrideProcessIsHidden(Boolean overrideProcessIsHidden)	Fluent setter for overrideProcessIsHidden
ApiProcessMetaData	withPath(String path)	Fluent setter for path
ApiProcessMetaData	withSummary(String summary)	Fluent setter for summary
ApiProcessMetaData	withTag(String tag)	Fluent setter for tag

Methods inherited from class java.lang.Object

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

Constructor Details

ApiProcessMetaData

public ApiProcessMetaData()

Method Details

getApiVersionRange

public APIVersionRange getApiVersionRange()

enrich

public void enrich(QInstanceEnricher qInstanceEnricher,
 String apiName,
 QProcessMetaData process)

getInitialVersion

public String getInitialVersion()

Getter for initialVersion

setInitialVersion

public void setInitialVersion(String initialVersion)

Setter for initialVersion

withInitialVersion

public ApiProcessMetaData withInitialVersion(String initialVersion)

Fluent setter for initialVersion

getFinalVersion

public String getFinalVersion()

Getter for finalVersion

setFinalVersion

public void setFinalVersion(String finalVersion)

Setter for finalVersion

withFinalVersion

public ApiProcessMetaData withFinalVersion(String finalVersion)

Fluent setter for finalVersion

getApiProcessName

public String getApiProcessName()

Getter for apiProcessName

setApiProcessName

public void setApiProcessName(String apiProcessName)

Setter for apiProcessName

withApiProcessName

public ApiProcessMetaData withApiProcessName(String apiProcessName)

Fluent setter for apiProcessName

getIsExcluded

public Boolean getIsExcluded()

Getter for isExcluded

setIsExcluded

public void setIsExcluded(Boolean isExcluded)

Setter for isExcluded

withIsExcluded

public ApiProcessMetaData withIsExcluded(Boolean isExcluded)

Fluent setter for isExcluded

getMethod

public HttpMethod getMethod()

Getter for method

setMethod

public void setMethod(HttpMethod method)

Setter for method

withMethod

public ApiProcessMetaData withMethod(HttpMethod method)

Fluent setter for method

getPath

public String getPath()

Getter for path

setPath

public void setPath(String path)

Setter for path

withPath

public ApiProcessMetaData withPath(String path)

Fluent setter for path

getCustomizers

public Map<String,QCodeReference> getCustomizers()

Getter for customizers

setCustomizers

public void setCustomizers(Map<String,QCodeReference> customizers)

Setter for customizers

withCustomizers

public ApiProcessMetaData withCustomizers(Map<String,QCodeReference> customizers)

Fluent setter for customizers

withCustomizer

public ApiProcessMetaData withCustomizer(String role,
 QCodeReference customizer)

getOutput

public ApiProcessOutputInterface getOutput()

Getter for output

setOutput

public void setOutput(ApiProcessOutputInterface output)

Setter for output

withOutput

public ApiProcessMetaData withOutput(ApiProcessOutputInterface output)

Fluent setter for output

getInput

public ApiProcessInput getInput()

Getter for input

setInput

public void setInput(ApiProcessInput input)

Setter for input

withInput

public ApiProcessMetaData withInput(ApiProcessInput input)

Fluent setter for input

getSummary

public String getSummary()

Getter for summary

setSummary

public void setSummary(String summary)

Setter for summary

withSummary

public ApiProcessMetaData withSummary(String summary)

Fluent setter for summary

getDescription

public String getDescription()

Getter for description

setDescription

public void setDescription(String description)

Setter for description

withDescription

public ApiProcessMetaData withDescription(String description)

Fluent setter for description

validate

public void validate(QInstance qInstance,
 QProcessMetaData process,
 QInstanceValidator qInstanceValidator,
 String apiName)

getAsyncMode

public ApiProcessMetaData.AsyncMode getAsyncMode()

Getter for asyncMode

setAsyncMode

public void setAsyncMode(ApiProcessMetaData.AsyncMode asyncMode)

Setter for asyncMode

withAsyncMode

public ApiProcessMetaData withAsyncMode(ApiProcessMetaData.AsyncMode asyncMode)

Fluent setter for asyncMode

getOverrideProcessIsHidden

public Boolean getOverrideProcessIsHidden()

Getter for overrideProcessIsHidden

setOverrideProcessIsHidden

public void setOverrideProcessIsHidden(Boolean overrideProcessIsHidden)

Setter for overrideProcessIsHidden

withOverrideProcessIsHidden

public ApiProcessMetaData withOverrideProcessIsHidden(Boolean overrideProcessIsHidden)

Fluent setter for overrideProcessIsHidden

getTag

public String getTag()

Getter for tag

setTag

public void setTag(String tag)

Setter for tag

withTag

public ApiProcessMetaData withTag(String tag)

Fluent setter for tag