public interface UDF extends Function, Dumpable, Member, java.lang.Cloneable
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 |
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
|
toDumpData
static final int RETURN_FORMAT_WDDX
static final int RETURN_FORMAT_JSON
static final int RETURN_FORMAT_PLAIN
static final int RETURN_FORMAT_SERIALIZE
static final int RETURN_FORMAT_XML
java.lang.Object implementation(PageContext pageContext) throws java.lang.Throwable
pageContext
- java.lang.Throwable
FunctionArgument[] getFunctionArguments()
PageException
java.lang.Object getDefaultValue(PageContext pc, int index) throws PageException
pc
- index
- PageException
java.lang.String getFunctionName()
boolean getOutput()
int getReturnType()
int getReturnFormat()
java.lang.Boolean getSecureJson()
java.lang.Boolean getVerifyClient()
java.lang.String getReturnTypeAsString()
java.lang.String getDescription()
java.lang.Object callWithNamedValues(PageContext pageContext, Struct values, boolean doIncludePath) throws PageException
pageContext
- values
- named valuesdoIncludePath
- PageException
java.lang.Object call(PageContext pageContext, java.lang.Object[] args, boolean doIncludePath) throws PageException
pageContext
- args
- parameters for the functiondoIncludePath
- PageException
java.lang.String getDisplayName()
java.lang.String getHint()
PageSource getPageSource()
Struct getMetaData(PageContext pc) throws PageException
PageException
UDF duplicate()
Component getOwnerComponent()