lucee.runtime.type

Interface UDF

All Superinterfaces:

java.lang.Cloneable, Dumpable, Function, Member, java.io.Serializable

All Known Subinterfaces:

ComponentMethod, UserDefinedFunction

public interface UDF
extends Function, Dumpable, Member, java.lang.Cloneable

a user defined function

Field Summary

Fields

Modifier and Type	Field and Description
static int	RETURN_FORMAT_JSON
static int	RETURN_FORMAT_PLAIN
static int	RETURN_FORMAT_SERIALIZE
static int	RETURN_FORMAT_WDDX
static int	RETURN_FORMAT_XML

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	call(PageContext pageContext, java.lang.Object[] args, boolean doIncludePath) call user defined Funcion with parameters as Object Array
java.lang.Object	callWithNamedValues(PageContext pageContext, Struct values, boolean doIncludePath) call user defined Funcion with a hashmap of named values
UDF	duplicate()
java.lang.Object	getDefaultValue(PageContext pc, int index)
java.lang.String	getDescription()
java.lang.String	getDisplayName()
FunctionArgument[]	getFunctionArguments() return all function arguments of this UDF
java.lang.String	getFunctionName()
java.lang.String	getHint()
Struct	getMetaData(PageContext pc)
boolean	getOutput()
Component	getOwnerComponent() Deprecated.
PageSource	getPageSource()
int	getReturnFormat()
int	getReturnType()
java.lang.String	getReturnTypeAsString()
java.lang.Boolean	getSecureJson() returns null when not defined
java.lang.Boolean	getVerifyClient() returns null when not defined
java.lang.Object	implementation(PageContext pageContext) abstract method for the function Body

Methods inherited from interface lucee.runtime.dump.Dumpable

toDumpData

Methods inherited from interface lucee.runtime.component.Member

getAccess, getValue

Field Detail

RETURN_FORMAT_WDDX

static final int RETURN_FORMAT_WDDX

See Also:

Constant Field Values

RETURN_FORMAT_JSON

static final int RETURN_FORMAT_JSON

See Also:

Constant Field Values

RETURN_FORMAT_PLAIN

static final int RETURN_FORMAT_PLAIN

See Also:

Constant Field Values

RETURN_FORMAT_SERIALIZE

static final int RETURN_FORMAT_SERIALIZE

See Also:

Constant Field Values

RETURN_FORMAT_XML

static final int RETURN_FORMAT_XML

See Also:

Constant Field Values

Method Detail

implementation

java.lang.Object implementation(PageContext pageContext)
                                throws java.lang.Throwable

abstract method for the function Body

Parameters:

pageContext -

Throws:

java.lang.Throwable

getFunctionArguments

FunctionArgument[] getFunctionArguments()

return all function arguments of this UDF

Returns:

the arguments.

Throws:

PageException

getDefaultValue

java.lang.Object getDefaultValue(PageContext pc,
                               int index)
                                 throws PageException

Parameters:

pc -

index -

Returns:

default value

Throws:

PageException

getFunctionName

java.lang.String getFunctionName()

Returns:

Returns the functionName.

getOutput

boolean getOutput()

Returns:

Returns the output.

getReturnType

int getReturnType()

Returns:

Returns the returnType.

getReturnFormat

int getReturnFormat()

getSecureJson

java.lang.Boolean getSecureJson()

returns null when not defined

Returns:

value of attribute securejson

getVerifyClient

java.lang.Boolean getVerifyClient()

returns null when not defined

Returns:

value of attribute verifyclient

getReturnTypeAsString

java.lang.String getReturnTypeAsString()

Returns:

Returns the returnType.

getDescription

java.lang.String getDescription()

callWithNamedValues

java.lang.Object callWithNamedValues(PageContext pageContext,
                                   Struct values,
                                   boolean doIncludePath)
                                     throws PageException

call user defined Funcion with a hashmap of named values

Parameters:

pageContext -

values - named values

doIncludePath -

Returns:

return value of the function

Throws:

PageException

call

java.lang.Object call(PageContext pageContext,
                    java.lang.Object[] args,
                    boolean doIncludePath)
                      throws PageException

call user defined Funcion with parameters as Object Array

Parameters:

pageContext -

args - parameters for the function

doIncludePath -

Returns:

return value of the function

Throws:

PageException

getDisplayName

java.lang.String getDisplayName()

Returns:

Returns the displayName.

getHint

java.lang.String getHint()

Returns:

Returns the hint.

getPageSource

PageSource getPageSource()

getMetaData

Struct getMetaData(PageContext pc)
                   throws PageException

Throws:

PageException

duplicate

UDF duplicate()

getOwnerComponent

Component getOwnerComponent()

Deprecated.

it is the component in whitch this udf is constructed, must not be the same as active udf

Returns:

owner component