abstract class %DeepSee.Query.function
extends group
This class defines a function within a DeepSee query.
The actual behavior of functions is implemented within the subclasses of this class.
• parameter FUNCTIONCLASS;
Used to indicate which class of functions this class supports.
• property function
as %DeepSee.Datatype.string(XMLPROJECTION="attribute");
Name of the function.
• property label
as %DeepSee.Datatype.string(XMLPROJECTION="attribute");
Label to display for the function (used internally).
• property subqueryKey
as %Integer(XMLPROJECTION="none");
Handle of subquery for this function (if needed).
• classmethod %BuildFunctionMetaData()
as %Status
Test if function metadata is in the DeepSeeFunctionGLVN global.
If not, put it there.
• final classmethod %GetFunctionInfo(pFunction As %String, Output pIsImplemented As %Boolean, Output pArgCount As %Integer, Output pReturns As %String, Output pArgTypes As %List, Output pArgDesc As %List)
as %Boolean
Return meta-data for the function pFunction.
Returns true if the function exists.
On return,
pIsImplemented if the function is implemented.
pArgCount returns the number of required arguments the function expects
or "" if this function does not take arguments.
pReturns is the return type.
pArgTypes is a list of argument types for the function.
pArgDesc is a list of argument descriptors for the function.
• final classmethod %GetFunctionSignature(pFunction As %String)
as %String
Return a string containing the signature for the given function
(used for error messages).
• method %GetType()
as %String
Return type of this node.
• classmethod %TypeFlagToString(pTypeFlag)
as %String
Convert a ds Type to a printable string.
Used for error reporting.
