Class ApiFieldUtils

java.lang.Object

com.kingsrook.qqq.api.actions.ApiFieldUtils

public class ApiFieldUtils
extends Object

utility methods for working with fields

Constructor Summary

Constructors

Constructor	Description
ApiFieldUtils()

Method Summary

Modifier and Type	Method	Description
static ApiFieldMetaData	getApiFieldMetaData(String apiName, QFieldMetaData field)
static APIVersionRange	getApiVersionRange(String apiName, QFieldMetaData field)
static APIVersionRange	getApiVersionRangeForRemovedField(String apiName, QFieldMetaData field)
static boolean	isIncluded(String apiName, QFieldMetaData field)
static boolean	isVirtualFieldIncluded(String apiName, QVirtualFieldMetaData field)	determine if a virtual field should be included in the api.

Methods inherited from class java.lang.Object

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

Constructor Details

ApiFieldUtils

public ApiFieldUtils()

Method Details

isIncluded

public static boolean isIncluded(String apiName,
 QFieldMetaData field)

isVirtualFieldIncluded

public static boolean isVirtualFieldIncluded(String apiName,
 QVirtualFieldMetaData field)

determine if a virtual field should be included in the api.

Note that the logic here is stricter than for normal fields. a virtual field must explicitly have api field meta data applied to it to be in the api.

getApiVersionRangeForRemovedField

public static APIVersionRange getApiVersionRangeForRemovedField(String apiName,
 QFieldMetaData field)

getApiVersionRange

public static APIVersionRange getApiVersionRange(String apiName,
 QFieldMetaData field)

getApiFieldMetaData

public static ApiFieldMetaData getApiFieldMetaData(String apiName,
 QFieldMetaData field)