Class ApiScriptUtils

java.lang.Object

com.kingsrook.qqq.api.utils.ApiScriptUtils

All Implemented Interfaces:

QCodeExecutorAware, Serializable

public class ApiScriptUtils
extends Object
implements QCodeExecutorAware, Serializable

Object injected into script context, for interfacing with a QQQ API.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ApiScriptUtils(String apiName, String apiVersion)	Constructor

Method Summary

Modifier and Type	Method	Description
List<Map<String,Serializable>>	bulkDelete(String tableApiName, Object body)
List<Map<String,Serializable>>	bulkInsert(String tableApiName, Object body)
List<Map<String,Serializable>>	bulkUpdate(String tableApiName, Object body)
void	delete(String tableApiName, Object primaryKey)
Map<String,Serializable>	get(String tableApiName, Object primaryKey)
Serializable	getProcessStatus(String processApiName, String jobId)
Map<String,Serializable>	insert(String tableApiName, Object body)
static ArrayList<Map<String,Serializable>>	qRecordListToApiRecordList(List<QRecord> qRecordList, String tableName, String apiName, String apiVersion)
Map<String,Serializable>	query(String tableName, String queryString)
Serializable	runProcess(String processApiName)
Serializable	runProcess(String processApiName, Object params)
void	setApiName(String apiName)	Setter for apiName
void	setApiVersion(String apiVersion)	Setter for apiVersion
void	setQCodeExecutor(QCodeExecutor qCodeExecutor)
void	update(String tableApiName, Object primaryKey, Object body)

Methods inherited from class java.lang.Object

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

Constructor Details

ApiScriptUtils

public ApiScriptUtils(String apiName,
 String apiVersion)

Constructor

Method Details

qRecordListToApiRecordList

public static ArrayList<Map<String,Serializable>> qRecordListToApiRecordList(List<QRecord> qRecordList,
 String tableName,
 String apiName,
 String apiVersion)
                                                                      throws QException

Throws:

QException

setApiName

public void setApiName(String apiName)

Setter for apiName

setApiVersion

public void setApiVersion(String apiVersion)

Setter for apiVersion

get

public Map<String,Serializable> get(String tableApiName,
 Object primaryKey)
                             throws QException

Throws:

QException

query

public Map<String,Serializable> query(String tableName,
 String queryString)
                               throws QException

Throws:

QException

insert

public Map<String,Serializable> insert(String tableApiName,
 Object body)
                                throws QException

Throws:

QException

bulkInsert

public List<Map<String,Serializable>> bulkInsert(String tableApiName,
 Object body)
                                          throws QException

Throws:

QException

update

public void update(String tableApiName,
 Object primaryKey,
 Object body)
            throws QException

Throws:

QException

bulkUpdate

public List<Map<String,Serializable>> bulkUpdate(String tableApiName,
 Object body)
                                          throws QException

Throws:

QException

delete

public void delete(String tableApiName,
 Object primaryKey)
            throws QException

Throws:

QException

bulkDelete

public List<Map<String,Serializable>> bulkDelete(String tableApiName,
 Object body)
                                          throws QException

Throws:

QException

runProcess

public Serializable runProcess(String processApiName)
                        throws QException

Throws:

QException

runProcess

public Serializable runProcess(String processApiName,
 Object params)
                        throws QException

Throws:

QException

getProcessStatus

public Serializable getProcessStatus(String processApiName,
 String jobId)
                              throws QException

Throws:

QException

setQCodeExecutor

public void setQCodeExecutor(QCodeExecutor qCodeExecutor)

Specified by:

setQCodeExecutor in interface QCodeExecutorAware