railo.runtime.type
Class UDFGSProperty

java.lang.Object
  extended by railo.runtime.component.MemberSupport
      extended by railo.runtime.type.UDFImpl
          extended by railo.runtime.type.UDFGSProperty
All Implemented Interfaces:
Externalizable, Serializable, Cloneable, Member, Dumpable, Function, Duplicable, Sizeable, UDF, UDFPlus
Direct Known Subclasses:
UDFAddProperty, UDFGetterProperty, UDFHasProperty, UDFRemoveProperty, UDFSetterProperty

public abstract class UDFGSProperty
extends UDFImpl

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
 
Constructor Summary
UDFGSProperty(ComponentImpl component, String name, FunctionArgument[] arguments, short rtnType, String rtnFormat)
           
 
Method Summary
 int getAccess()
          return the access modifier of this member
 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()
          it is the component in whitch this udf is constructed, must not be the same as active udf
 Page getPage()
           
 int getReturnFormat()
           
 int getReturnType()
           
 Boolean getSecureJson()
          returns null when not defined
 Object getValue()
          return the value itself
 Boolean getVerifyClient()
          returns null when not defined
 DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties properties)
          method to print out information to a object as HTML
 
Methods inherited from class railo.runtime.type.UDFImpl
argumentCollection, argumentCollection, call, callWithNamedValues, clone, duplicate, duplicate, duplicate, equals, equals, getBufferOutput, getDefaultValue, getDefaultValue, getIndex, getMeta, getPageSource, getReturnFormatAsString, getReturnTypeAsString, implementation, readExternal, setOwnerComponent, sizeOf, toDumpData, toKey, toReturnFormat, toReturnFormat, toReturnFormat, toString, writeExternal
 
Methods inherited from class railo.runtime.component.MemberSupport
setAccess, setAccess
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UDFGSProperty

public UDFGSProperty(ComponentImpl component,
                     String name,
                     FunctionArgument[] arguments,
                     short rtnType,
                     String rtnFormat)
Method Detail

getFunctionArguments

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

Specified by:
getFunctionArguments in interface UDF
Overrides:
getFunctionArguments in class UDFImpl
Returns:
the arguments.

getFunctionName

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

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
Overrides:
getOwnerComponent in class UDFImpl
Returns:
owner component

getPage

public Page getPage()

getOutput

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

getAccess

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

Specified by:
getAccess in interface Member
Overrides:
getAccess in class MemberSupport
Returns:
the access

getDisplayName

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

getDescription

public String getDescription()
Specified by:
getDescription in interface UDF
Overrides:
getDescription in class UDFImpl

getHint

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

getReturnFormat

public int getReturnFormat()
Specified by:
getReturnFormat in interface UDF
Overrides:
getReturnFormat in class UDFImpl

getReturnType

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

getValue

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

Specified by:
getValue in interface Member
Overrides:
getValue in class UDFImpl
Returns:
value

getSecureJson

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

Specified by:
getSecureJson in interface UDF
Overrides:
getSecureJson in class UDFImpl
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
Overrides:
getVerifyClient in class UDFImpl
Returns:
value of attribute verifyclient

toDumpData

public DumpData toDumpData(PageContext pageContext,
                           int maxlevel,
                           DumpProperties properties)
Description copied from interface: Dumpable
method to print out information to a object as HTML

Specified by:
toDumpData in interface Dumpable
Overrides:
toDumpData in class UDFImpl
Returns:
HTML print out

getMetaData

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


Copyright © 2012 Railo