public abstract class UDFGSProperty 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 |
---|
UDFGSProperty(ComponentImpl component,
String name,
FunctionArgument[] arguments,
short rtnType,
String rtnFormat) |
Modifier and Type | Method and Description |
---|---|
Object |
call(PageContext pc,
Collection.Key calledName,
Object[] args,
boolean doIncludePath)
call user defined Funcion with parameters as Object Array
|
Object |
callWithNamedValues(PageContext pc,
Collection.Key calledName,
Struct values,
boolean doIncludePath)
call user defined Funcion with a struct
|
UDF |
duplicate(boolean deep) |
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
|
Page |
getPage() |
PageSource |
getPageSource() |
int |
getReturnFormat() |
int |
getReturnFormat(int defaultValue) |
int |
getReturnType() |
Boolean |
getSecureJson()
returns null when not defined
|
Object |
getValue()
return the value itself
|
Boolean |
getVerifyClient()
returns null when not defined
|
void |
setOwnerComponent(ComponentImpl component) |
DumpData |
toDumpData(PageContext pageContext,
int maxlevel,
DumpProperties properties)
method to print out information to a object as HTML
|
getAccess, setAccess, setAccess
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDefaultValue, setAccess
call, callWithNamedValues, duplicate, getDefaultValue, getReturnTypeAsString, implementation
public UDFGSProperty(ComponentImpl component, String name, FunctionArgument[] arguments, short rtnType, String rtnFormat)
public FunctionArgument[] getFunctionArguments()
UDF
getFunctionArguments
in interface UDF
public String getFunctionName()
getFunctionName
in interface UDF
public PageSource getPageSource()
getPageSource
in interface UDF
public Component getOwnerComponent()
UDF
getOwnerComponent
in interface UDF
public void setOwnerComponent(ComponentImpl component)
setOwnerComponent
in interface UDFPlus
public boolean getOutput()
public UDF duplicate(boolean deep)
duplicate
in interface Duplicable
public String getDisplayName()
getDisplayName
in interface UDF
public String getDescription()
getDescription
in interface UDF
public int getReturnFormat()
getReturnFormat
in interface UDF
public int getReturnFormat(int defaultValue)
getReturnFormat
in interface UDFPlus
public int getReturnType()
getReturnType
in interface UDF
public Boolean getSecureJson()
UDF
getSecureJson
in interface UDF
public Boolean getVerifyClient()
UDF
getVerifyClient
in interface UDF
public DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties properties)
Dumpable
toDumpData
in interface Dumpable
public Struct getMetaData(PageContext pc) throws PageException
getMetaData
in interface UDF
PageException
public Object callWithNamedValues(PageContext pc, Collection.Key calledName, Struct values, boolean doIncludePath) throws PageException
UDFPlus
callWithNamedValues
in interface UDFPlus
values
- named valuesPageException
public Object call(PageContext pc, Collection.Key calledName, Object[] args, boolean doIncludePath) throws PageException
UDFPlus
call
in interface UDFPlus
args
- parameters for the functionPageException
Copyright © 2015 Lucee