railo.runtime.type.trace
Class TOUDF

java.lang.Object
  extended by railo.runtime.type.trace.TraceObjectSupport
      extended by railo.runtime.type.trace.TOObjects
          extended by railo.runtime.type.trace.TOUDF
All Implemented Interfaces:
Serializable, Cloneable, Member, Dumpable, Function, Castable, Objects, TraceObject, UDF, UDFPlus

public class TOUDF
extends TOObjects
implements UDFPlus

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface railo.runtime.type.UDF
RETURN_FORMAT_JSON, RETURN_FORMAT_PLAIN, RETURN_FORMAT_SERIALIZE, RETURN_FORMAT_WDDX, 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()
           
 int getAccess()
          return the access modifier of this member
 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 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
 
Methods inherited from class railo.runtime.type.trace.TOObjects
call, callWithNamedValues, castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo, get, get, isInitalized, set, setEL, toDumpData
 
Methods inherited from class railo.runtime.type.trace.TraceObjectSupport
equals, log, toString, toTraceObject
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface railo.runtime.dump.Dumpable
toDumpData
 

Method Detail

getAccess

public int getAccess()
Description copied from interface: Member
return the access modifier of this member

Specified by:
getAccess in interface Member
Returns:
the access

getValue

public Object getValue()
Description copied from interface: Member
return the value itself

Specified by:
getValue in interface Member
Returns:
value

implementation

public Object implementation(PageContext pageContext)
                      throws Throwable
Description copied from interface: UDF
abstract method for the function Body

Specified by:
implementation in interface UDF
Throws:
Throwable

getFunctionArguments

public FunctionArgument[] getFunctionArguments()
Description copied from interface: UDF
return all function arguments of this UDF

Specified by:
getFunctionArguments in interface UDF
Returns:
the arguments.

getDefaultValue

public Object getDefaultValue(PageContext pc,
                              int index)
                       throws PageException
Specified by:
getDefaultValue in interface UDF
Returns:
default value
Throws:
PageException

getDefaultValue

public Object getDefaultValue(PageContext pc,
                              int index,
                              Object defaultValue)
                       throws PageException
Specified by:
getDefaultValue in interface UDFPlus
Throws:
PageException

getFunctionName

public String getFunctionName()
Specified by:
getFunctionName in interface UDF
Returns:
Returns the functionName.

getOutput

public boolean getOutput()
Specified by:
getOutput in interface UDF
Returns:
Returns the output.

getReturnType

public int getReturnType()
Specified by:
getReturnType in interface UDF
Returns:
Returns the returnType.

getReturnFormat

public int getReturnFormat()
Specified by:
getReturnFormat in interface UDF

getSecureJson

public Boolean getSecureJson()
Description copied from interface: UDF
returns null when not defined

Specified by:
getSecureJson in interface UDF
Returns:
value of attribute securejson

getVerifyClient

public Boolean getVerifyClient()
Description copied from interface: UDF
returns null when not defined

Specified by:
getVerifyClient in interface UDF
Returns:
value of attribute verifyclient

getReturnTypeAsString

public String getReturnTypeAsString()
Specified by:
getReturnTypeAsString in interface UDF
Returns:
Returns the returnType.

getDescription

public String getDescription()
Specified by:
getDescription in interface UDF

callWithNamedValues

public Object callWithNamedValues(PageContext pageContext,
                                  Struct values,
                                  boolean doIncludePath)
                           throws PageException
Description copied from interface: UDF
call user defined Funcion with a hashmap of named values

Specified by:
callWithNamedValues in interface UDF
values - named values
Returns:
return value of the function
Throws:
PageException

call

public Object call(PageContext pageContext,
                   Object[] args,
                   boolean doIncludePath)
            throws PageException
Description copied from interface: UDF
call user defined Funcion with parameters as Object Array

Specified by:
call in interface UDF
args - parameters for the function
Returns:
return value of the function
Throws:
PageException

getDisplayName

public String getDisplayName()
Specified by:
getDisplayName in interface UDF
Returns:
Returns the displayName.

getHint

public String getHint()
Specified by:
getHint in interface UDF
Returns:
Returns the hint.

getPageSource

public PageSource getPageSource()
Specified by:
getPageSource in interface UDF

getIndex

public int getIndex()
Specified by:
getIndex in interface UDFPlus

getMetaData

public Struct getMetaData(PageContext pc)
                   throws PageException
Specified by:
getMetaData in interface UDF
Throws:
PageException

duplicate

public UDF duplicate()
Specified by:
duplicate in interface UDF

getOwnerComponent

public Component getOwnerComponent()
Description copied from interface: UDF
it is the component in whitch this udf is constructed, must not be the same as active udf

Specified by:
getOwnerComponent in interface UDF
Returns:
owner component


Copyright © 2012 Railo