Package com.tccc.kos.ext.dispense.service.ingredient

Class IngredientFilter

java.lang.Object

com.tccc.kos.ext.dispense.service.insertion.InsertionFilter<InsertionFilterConfig>

com.tccc.kos.ext.dispense.service.ingredient.IngredientFilter

All Implemented Interfaces:

com.tccc.kos.commons.core.service.config.ConfigAware<InsertionFilterConfig>, com.tccc.kos.commons.core.service.handle.HandleAware

public final class IngredientFilter
extends InsertionFilter<InsertionFilterConfig>

Insertion filter that blocks insertions of unknown ingredients. Since insertion is global but ingredients can be as granular as per-holder, this filter needs to check the holders in the request and check each ingredient accordingly.

Since:

1.0

Version:

2023-02-06

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
IngredientFilter()	Create a new filter.

Method Summary

Modifier and Type	Method	Description
void	checkRequest(InsertRequest request)	Called to verify if an InsertRequest can be inserted.

Methods inherited from class com.tccc.kos.ext.dispense.service.insertion.InsertionFilter

checkPumpRequest, getConfig, getGroup, getHandle, getPosition, setConfig, setHandle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tccc.kos.commons.core.service.config.ConfigAware

onConfigChanged, onConfigSet

Methods inherited from interface com.tccc.kos.commons.core.service.handle.HandleAware

addHandleChild, getName, getPath

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

IngredientFilter

public IngredientFilter()

Create a new filter.

Method Details

checkRequest

public void checkRequest(InsertRequest request)

Description copied from class: InsertionFilter

Called to verify if an InsertRequest can be inserted. Use request.block() to prevent the request from proceeding. To attach a trouble to the request but still allow the request to move forward, use request.warn() .

Specified by:

checkRequest in class InsertionFilter<InsertionFilterConfig>

Parameters:

request - the request to operate on