public class BIF extends MemberSupport implements UDFPlus
RETURN_FORMAT_JAVA
RETURN_FORMAT_JSON, RETURN_FORMAT_PLAIN, RETURN_FORMAT_SERIALIZE, RETURN_FORMAT_WDDX, RETURN_FORMAT_XML
Constructor and Description |
---|
BIF(Config config,
FunctionLibFunction flf) |
BIF(Config config,
String name) |
Modifier and Type | Method and Description |
---|---|
Object |
call(PageContext pageContext,
Collection.Key calledName,
Object[] args,
boolean doIncludePath)
call user defined Funcion with parameters as Object Array
|
Object |
call(PageContext pageContext,
Object[] args,
boolean doIncludePath)
call user defined Funcion with parameters as Object Array
|
Object |
callWithNamedValues(PageContext pageContext,
Collection.Key calledName,
Struct values,
boolean doIncludePath)
call user defined Funcion with a struct
|
Object |
callWithNamedValues(PageContext pageContext,
Struct values,
boolean doIncludePath)
call user defined Funcion with a hashmap of named values
|
UDF |
duplicate() |
Object |
duplicate(boolean deepCopy) |
Object |
getDefaultValue(PageContext pc,
int index) |
Object |
getDefaultValue(PageContext pc,
int index,
Object defaultValue) |
String |
getDescription() |
String |
getDisplayName() |
FunctionArgument[] |
getFunctionArguments()
return all function arguments of this UDF
|
String |
getFunctionName() |
String |
getHint() |
int |
getIndex() |
Struct |
getMetaData(PageContext pc) |
boolean |
getOutput() |
Component |
getOwnerComponent()
it is the component in whitch this udf is constructed, must not be the same as active udf
|
PageSource |
getPageSource() |
int |
getReturnFormat() |
int |
getReturnFormat(int defaultFormat) |
int |
getReturnType() |
String |
getReturnTypeAsString() |
Boolean |
getSecureJson()
returns null when not defined
|
Object |
getValue()
return the value itself
|
Boolean |
getVerifyClient()
returns null when not defined
|
Object |
implementation(PageContext pageContext)
abstract method for the function Body
|
void |
setOwnerComponent(ComponentImpl owner) |
DumpData |
toDumpData(PageContext pageContext,
int maxlevel,
DumpProperties dp)
method to print out information to a object as HTML
|
getAccess, setAccess, setAccess
public BIF(Config config, String name) throws ApplicationException
ApplicationException
public BIF(Config config, FunctionLibFunction flf)
public FunctionArgument[] getFunctionArguments()
UDF
getFunctionArguments
in interface UDF
public Object callWithNamedValues(PageContext pageContext, Struct values, boolean doIncludePath) throws PageException
UDF
callWithNamedValues
in interface UDF
values
- named valuesPageException
public Object call(PageContext pageContext, Object[] args, boolean doIncludePath) throws PageException
UDF
call
in interface UDF
args
- parameters for the functionPageException
public Object callWithNamedValues(PageContext pageContext, Collection.Key calledName, Struct values, boolean doIncludePath) throws PageException
UDFPlus
callWithNamedValues
in interface UDFPlus
values
- named valuesPageException
public Object call(PageContext pageContext, Collection.Key calledName, Object[] args, boolean doIncludePath) throws PageException
UDFPlus
call
in interface UDFPlus
args
- parameters for the functionPageException
public DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
Dumpable
toDumpData
in interface Dumpable
public Object duplicate(boolean deepCopy)
duplicate
in interface Duplicable
public Component getOwnerComponent()
UDF
getOwnerComponent
in interface UDF
public String getDisplayName()
getDisplayName
in interface UDF
public String getFunctionName()
getFunctionName
in interface UDF
public int getReturnType()
getReturnType
in interface UDF
public String getDescription()
getDescription
in interface UDF
public void setOwnerComponent(ComponentImpl owner)
setOwnerComponent
in interface UDFPlus
public int getReturnFormat(int defaultFormat)
getReturnFormat
in interface UDFPlus
public int getReturnFormat()
getReturnFormat
in interface UDF
public String getReturnTypeAsString()
getReturnTypeAsString
in interface UDF
public boolean getOutput()
public Object getDefaultValue(PageContext pc, int index) throws PageException
getDefaultValue
in interface UDF
PageException
public Boolean getSecureJson()
UDF
getSecureJson
in interface UDF
public Boolean getVerifyClient()
UDF
getVerifyClient
in interface UDF
public PageSource getPageSource()
getPageSource
in interface UDF
public Object getDefaultValue(PageContext pc, int index, Object defaultValue) throws PageException
getDefaultValue
in interface UDFPlus
PageException
public Struct getMetaData(PageContext pc) throws PageException
getMetaData
in interface UDF
PageException
public Object implementation(PageContext pageContext) throws Throwable
UDF
implementation
in interface UDF
Throwable
Copyright © 2015 Lucee