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)	Deprecated.
static List<QFieldMetaData>	getTableApiFieldList(GetTableApiFieldsInput input)	convenience (and caching) wrapper
static Map<String,QFieldMetaData>	getTableApiFieldMap(GetTableApiFieldsAction.ApiNameVersionAndTableName apiNameVersionAndTableName)	Deprecated.
static Map<String,QFieldMetaData>	getTableApiFieldMap(GetTableApiFieldsInput input)	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

@Deprecated(since="0.27.0 - call the overload that takes Input object")
public static Map<String,QFieldMetaData> getTableApiFieldMap(GetTableApiFieldsAction.ApiNameVersionAndTableName apiNameVersionAndTableName)
                                                      throws QException

Deprecated.

With the introduction of TablePersonalization in 0.27, if an instance has a table personalizer, it is expected that such personalization may or may not need to apply based on the InputSource of the action (e.g., USER vs SYSTEM). As such, that property needs to be known in this method chain, so, the former input here is no longer adequate - hence, deprecated. If this method is used, the default input source of SYSTEM will be used, so a table-personalizer that only applies for inputSource=USER would not be applied.

Throws:

QException

getTableApiFieldMap

public static Map<String,QFieldMetaData> getTableApiFieldMap(GetTableApiFieldsInput input)
                                                      throws QException

convenience (and caching) wrapper

Throws:

QException

getTableApiFieldList

@Deprecated(since="0.27.0 - call the overload that takes Input object")
public static List<QFieldMetaData> getTableApiFieldList(GetTableApiFieldsAction.ApiNameVersionAndTableName apiNameVersionAndTableName)
                                                 throws QException

Deprecated.

Throws:

QException

See Also:

• for comment on deprecation here re: table personalization and input source.

getTableApiFieldList

public static List<QFieldMetaData> getTableApiFieldList(GetTableApiFieldsInput input)
                                                 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