Class FieldFunctionParameter

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.fields.functions.FieldFunctionParameter

public class FieldFunctionParameter
extends Object

Describes a single parameter accepted by a FieldFunctionType.

Each parameter has a name used as its key in the arguments map, a declared QFieldType, a flag indicating whether it is required, and an optional default value used when the argument is not explicitly supplied.

Constructor Summary

Constructors

Constructor	Description
FieldFunctionParameter()

Method Summary

Modifier and Type	Method	Description
Serializable	getDefaultValue()	Getter for defaultValue
boolean	getIsRequired()	Getter for isRequired
String	getName()	Getter for name
QFieldType	getType()	Getter for type
void	setDefaultValue(Serializable defaultValue)	Setter for defaultValue
void	setIsRequired(boolean isRequired)	Setter for isRequired
void	setName(String name)	Setter for name
void	setType(QFieldType type)	Setter for type
FieldFunctionParameter	withDefaultValue(Serializable defaultValue)	Fluent setter for defaultValue
FieldFunctionParameter	withIsRequired(boolean isRequired)	Fluent setter for isRequired
FieldFunctionParameter	withName(String name)	Fluent setter for name
FieldFunctionParameter	withType(QFieldType type)	Fluent setter for type

Methods inherited from class java.lang.Object

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

Constructor Details

FieldFunctionParameter

public FieldFunctionParameter()

Method Details

getName

public String getName()

Getter for name

See Also:

• withName(String)

setName

public void setName(String name)

Setter for name

See Also:

• withName(String)

withName

public FieldFunctionParameter withName(String name)

Fluent setter for name

Parameters:

name - The parameter's name, used as the key in the FieldFunction arguments map.

Returns:

this

getType

public QFieldType getType()

Getter for type

See Also:

• withType(QFieldType)

setType

public void setType(QFieldType type)

Setter for type

See Also:

• withType(QFieldType)

withType

public FieldFunctionParameter withType(QFieldType type)

Fluent setter for type

Parameters:

type - The expected QFieldType of this parameter's value.

Returns:

this

getIsRequired

public boolean getIsRequired()

Getter for isRequired

See Also:

• withIsRequired(boolean)

setIsRequired

public void setIsRequired(boolean isRequired)

Setter for isRequired

See Also:

• withIsRequired(boolean)

withIsRequired

public FieldFunctionParameter withIsRequired(boolean isRequired)

Fluent setter for isRequired

Parameters:

isRequired - Whether this parameter must be explicitly provided; defaults to true.

Returns:

this

getDefaultValue

public Serializable getDefaultValue()

Getter for defaultValue

See Also:

• withDefaultValue(Serializable)

setDefaultValue

public void setDefaultValue(Serializable defaultValue)

Setter for defaultValue

See Also:

• withDefaultValue(Serializable)

withDefaultValue

public FieldFunctionParameter withDefaultValue(Serializable defaultValue)

Fluent setter for defaultValue

Parameters:

defaultValue - The value to use when this parameter is not supplied in the FieldFunction arguments.

Returns:

this