Class GetTableApiFieldsAction

java.lang.Object

com.kingsrook.qqq.backend.core.actions.AbstractQActionFunction<GetTableApiFieldsInput,GetTableApiFieldsOutput>

com.kingsrook.qqq.api.actions.GetTableApiFieldsAction

public class GetTableApiFieldsAction
extends AbstractQActionFunction<GetTableApiFieldsInput,GetTableApiFieldsOutput>

For a given table (name) and API version, return the list of fields that apply for the API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GetTableApiFieldsAction.ApiNameVersionAndTableName	Input-record for convenience methods

Constructor Summary

Constructors

Constructor	Description
GetTableApiFieldsAction()

Method Summary

Modifier and Type	Method	Description
static void	clearCaches()	Allow tests (that manipulate meta-data) to clear field caches.
GetTableApiFieldsOutput	execute(GetTableApiFieldsInput input)
static List<QFieldMetaData>	getTableApiFieldList(GetTableApiFieldsAction.ApiNameVersionAndTableName apiNameVersionAndTableName)	convenience (and caching) wrapper
static Map<String,QFieldMetaData>	getTableApiFieldMap(GetTableApiFieldsAction.ApiNameVersionAndTableName apiNameVersionAndTableName)	convenience (and caching) wrapper

Methods inherited from class com.kingsrook.qqq.backend.core.actions.AbstractQActionFunction

executeAsync

Methods inherited from class java.lang.Object

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

Constructor Details

GetTableApiFieldsAction

public GetTableApiFieldsAction()

Method Details

clearCaches

public static void clearCaches()

Allow tests (that manipulate meta-data) to clear field caches.

getTableApiFieldMap

public static Map<String,QFieldMetaData> getTableApiFieldMap(GetTableApiFieldsAction.ApiNameVersionAndTableName apiNameVersionAndTableName)
                                                      throws QException

convenience (and caching) wrapper

Throws:

QException

getTableApiFieldList

public static List<QFieldMetaData> getTableApiFieldList(GetTableApiFieldsAction.ApiNameVersionAndTableName apiNameVersionAndTableName)
                                                 throws QException

convenience (and caching) wrapper

Throws:

QException

execute

public GetTableApiFieldsOutput execute(GetTableApiFieldsInput input)
                                throws QException

Specified by:

execute in class AbstractQActionFunction<GetTableApiFieldsInput,GetTableApiFieldsOutput>

Throws:

QException