|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UDF
a user defined function
Field Summary | |
---|---|
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 | |
---|---|
Object |
call(PageContext pageContext,
Object[] args,
boolean doIncludePath)
call user defined Funcion with parameters as Object Array |
Object |
callWithNamedValues(PageContext pageContext,
Struct values,
boolean doIncludePath)
call user defined Funcion with a hashmap of named values |
UDF |
duplicate()
|
Object |
getDefaultValue(PageContext pc,
int index)
|
String |
getDescription()
|
String |
getDisplayName()
|
FunctionArgument[] |
getFunctionArguments()
return all function arguments of this UDF |
String |
getFunctionName()
|
String |
getHint()
|
Struct |
getMetaData(PageContext pc)
|
boolean |
getOutput()
|
Component |
getOwnerComponent()
Deprecated. |
PageSource |
getPageSource()
|
int |
getReturnFormat()
|
int |
getReturnType()
|
String |
getReturnTypeAsString()
|
Boolean |
getSecureJson()
returns null when not defined |
Boolean |
getVerifyClient()
returns null when not defined |
Object |
implementation(PageContext pageContext)
abstract method for the function Body |
Methods inherited from interface railo.runtime.dump.Dumpable |
---|
toDumpData |
Methods inherited from interface railo.runtime.component.Member |
---|
getAccess, getValue |
Field Detail |
---|
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
Method Detail |
---|
Object implementation(PageContext pageContext) throws Throwable
pageContext
-
Throwable
FunctionArgument[] getFunctionArguments()
PageException
Object getDefaultValue(PageContext pc, int index) throws PageException
pc
- index
-
PageException
String getFunctionName()
boolean getOutput()
int getReturnType()
int getReturnFormat()
Boolean getSecureJson()
Boolean getVerifyClient()
String getReturnTypeAsString()
String getDescription()
Object callWithNamedValues(PageContext pageContext, Struct values, boolean doIncludePath) throws PageException
pageContext
- values
- named valuesdoIncludePath
-
PageException
Object call(PageContext pageContext, Object[] args, boolean doIncludePath) throws PageException
pageContext
- args
- parameters for the functiondoIncludePath
-
PageException
String getDisplayName()
String getHint()
PageSource getPageSource()
Struct getMetaData(PageContext pc) throws PageException
PageException
UDF duplicate()
Component getOwnerComponent()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |