All Superinterfaces:

Serializable

All Known Implementing Classes:

ConcatFunction, Crypto.CreateKey, Crypto.Decrypt, Crypto.Encrypt, Crypto.ExportJWKS, Crypto.GetPublicKey, Crypto.ImportJWKS, Crypto.SymmetricDecrypt, Crypto.SymmetricEncrypt, DynamoDB.Close, DynamoDB.Get, DynamoDB.Open, DynamoDB.PartitionKeyFunction, DynamoDB.RegionFunction, DynamoDB.Regions, DynamoDB.TableNameFunction, ExtrinsicFunction, FEvalFunction, HTTPClient.Close, HTTPClient.CreateCredentials, HTTPClient.Delete, HTTPClient.Download, HTTPClient.Get, HTTPClient.Headers, HTTPClient.Host, HTTPClient.IsJSON, HTTPClient.IsOpen, HTTPClient.IsText, HTTPClient.Open, HTTPClient.Post, HTTPClient.Put, QDLCLITools.ToStem, QDLConvert.GetAttributes, QDLConvert.HOCONExport, QDLConvert.HOCONImport, QDLConvert.IniExport, QDLConvert.IniImport, QDLConvert.QDLExport, QDLConvert.QDLImport, QDLConvert.Snarf, QDLConvert.XMLExport, QDLConvert.XMLImport, QDLConvert.YAMLExport, QDLConvert.YAMLImport, QDLDB.BatchExecute, QDLDB.BatchRead, QDLDB.Connect, QDLDB.Execute, QDLDB.Read, QDLDB.Update, QDLMail.Send, QDLMail.SetCfg, StatefulExample.GetS, StatefulExample.SetS
```
public interface QDLFunction
extends Serializable
```
A wrapper for a single Java method that can be invoked from QDL. It may indeed be a single utility, or it may front an entire class and expose the methods in it call just hands this class back. You could, for instance, have a single Java object with several methods, each of which holds a reference to the object and invokes a method on it. There are may possibilities.
Created by Jeff Gaynor
on 1/27/20 at 12:02 PM

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Object`	`evaluate(Object[] objects, State state)`	The method that is invoked by QDL that is the function.
`int[]`	`getArgCount()`	The contract is that when QDL invokes this method, it will faithfully give all of the arguments as an array of Objects.
`List<String>`	`getDocumentation(int argCount)`	Return documentation to be displayed in the workspace.
`String`	`getName()`	The name of this function as you want it invoked in QDL.

- Method Detail
  - getName
```
String getName()
```
    The name of this function as you want it invoked in QDL. This will be what the function is called in the workspace.
    
    Returns:
  - getArgCount
```
int[] getArgCount()
```
    The contract is that when QDL invokes this method, it will faithfully give all of the arguments as an array of Objects. Overloading is not possible in QDL (it is weakly typed) except by argument count, so if this is called "foo" and you have versions with 3 and 4 arguments, then f(a,b,c) would be executed with the arguments passed. To achieve overloading for Java methods, have the number of arguments this accepts as the elements of the array. So if this has a value of [1,2,3] then this function will be invoked if called with 1, 2 or 3 arguments and an error by the QDL runtime engine will be raised, if, say, 4 are passed.
    
    Returns:
  - evaluate
```
Object evaluate(Object[] objects,
                State state)
         throws Throwable
```
    The method that is invoked by QDL that is the function. It will have the arguments already evaluated and put in to the array of objects. It is up to you to do any checking you see fit. State is supplied if needed.
    
    Parameters:
    
    objects -
    
    state -
    
    Returns:
    
    Throws:
    
    Throwable
  - getDocumentation
```
List<String> getDocumentation(int argCount)
```
    Return documentation to be displayed in the workspace. Short version displays the first line (element of the list) so make sure that is informative. The long version should contain details of use. Best practice is that have a succinct one line description for each arg count and a body that explains the usage more fully.
    
    Returns:

Interface QDLFunction

Method Summary

Method Detail

getName

getArgCount

evaluate

getDocumentation