Class ApiFieldCustomValueMapper

java.lang.Object

com.kingsrook.qqq.api.model.actions.ApiFieldCustomValueMapper

public abstract class ApiFieldCustomValueMapper
extends Object

Constructor Summary

Constructors

Constructor	Description
ApiFieldCustomValueMapper()

Method Summary

Modifier and Type	Method	Description
void	consumeApiValue(QRecord record, Object value, org.json.JSONObject fullApiJsonObject, String apiFieldName)	When producing a QRecord (the first parameter) from a JSON Object that was received from the API (e.g., a POST or PATCH) - this method can run to allow customization of the incoming value.
void	customizeFilterCriteria(QueryInput queryInput, QQueryFilter filter, QFilterCriteria criteria, String apiFieldName, ApiFieldMetaData apiFieldMetaData)	Deprecated.
void	customizeFilterCriteriaForQueryOrCount(QueryOrCountInputInterface input, QQueryFilter filter, QFilterCriteria criteria, String apiFieldName, ApiFieldMetaData apiFieldMetaData)
void	customizeFilterOrderBy(QueryInput queryInput, QFilterOrderBy orderBy, String apiFieldName, ApiFieldMetaData apiFieldMetaData)
Serializable	produceApiValue(QRecord record, String apiFieldName)	When producing a JSON Object to send over the API (e.g., for a GET), this method can run to customize the value that is produced, for the input QRecord's specified fieldName

Methods inherited from class java.lang.Object

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

Constructor Details

ApiFieldCustomValueMapper

public ApiFieldCustomValueMapper()

Method Details

produceApiValue

public Serializable produceApiValue(QRecord record,
 String apiFieldName)

When producing a JSON Object to send over the API (e.g., for a GET), this method can run to customize the value that is produced, for the input QRecord's specified fieldName

consumeApiValue

public void consumeApiValue(QRecord record,
 Object value,
 org.json.JSONObject fullApiJsonObject,
 String apiFieldName)

When producing a QRecord (the first parameter) from a JSON Object that was received from the API (e.g., a POST or PATCH) - this method can run to allow customization of the incoming value.

customizeFilterCriteria

@Deprecated(since="0.26.0 changed QueryInput to QueryOrCountInputInterface")
public void customizeFilterCriteria(QueryInput queryInput,
 QQueryFilter filter,
 QFilterCriteria criteria,
 String apiFieldName,
 ApiFieldMetaData apiFieldMetaData)

Deprecated.

customizeFilterCriteriaForQueryOrCount

public void customizeFilterCriteriaForQueryOrCount(QueryOrCountInputInterface input,
 QQueryFilter filter,
 QFilterCriteria criteria,
 String apiFieldName,
 ApiFieldMetaData apiFieldMetaData)

customizeFilterOrderBy

public void customizeFilterOrderBy(QueryInput queryInput,
 QFilterOrderBy orderBy,
 String apiFieldName,
 ApiFieldMetaData apiFieldMetaData)