railo.runtime.util
Interface VariableUtil

All Known Implementing Classes:
VariableUtilImpl

public interface VariableUtil

Variable Util


Method Summary
 Object callFunction(PageContext pc, Object coll, String key, Object[] args)
          call a Function (UDF, Method) with or witout named values
 Object callFunctionWithNamedValues(PageContext pc, Object coll, String key, Object[] args)
          call a Function (UDF, Method) with Named Values
 Object callFunctionWithoutNamedValues(PageContext pc, Object coll, String key, Object[] args)
          call a Function (UDF, Method) without Named Values
 Object get(PageContext pc, Object coll, String key)
          return a property from the given Object, when property doesn't exists throw exception
 Object get(PageContext pc, Object coll, String key, Object defaultValue)
          return a property from the given Object, when property doesn't exists return null
 Object getCollection(PageContext pc, Object coll, String key)
          return a property from the given Object, when coll is a query return a Column,when property doesn't exists throw exception
 Object getCollection(PageContext pc, Object coll, String key, Object defaultValue)
          return a property from the given Object, when property doesn't exists return null
 Object getLight(PageContext pc, Object coll, String key, Object defaultValue)
          return a property from the given Object, when property doesn't exists return null
 Object remove(Object coll, String key)
          clear value from Collection
 Object removeEL(Object coll, String key)
          remove value from Collection
 Object set(PageContext pc, Object coll, String key, Object value)
          sets a value to the Object
 Object setEL(PageContext pc, Object coll, String key, Object value)
          sets a value to the Object
 

Method Detail

getCollection

Object getCollection(PageContext pc,
                     Object coll,
                     String key,
                     Object defaultValue)
return a property from the given Object, when property doesn't exists return null

Parameters:
pc -
coll - Collection to check
key - to get from Collection
Returns:
value or null

get

Object get(PageContext pc,
           Object coll,
           String key,
           Object defaultValue)
return a property from the given Object, when property doesn't exists return null

Parameters:
pc -
coll - Collection to check
key - to get from Collection
Returns:
value or null

getLight

Object getLight(PageContext pc,
                Object coll,
                String key,
                Object defaultValue)
return a property from the given Object, when property doesn't exists return null

Parameters:
pc -
coll - Collection to check
key - to get from Collection
Returns:
value or null

getCollection

Object getCollection(PageContext pc,
                     Object coll,
                     String key)
                     throws PageException
return a property from the given Object, when coll is a query return a Column,when property doesn't exists throw exception

Parameters:
pc -
coll - Collection to check
key - to get from Collection
Returns:
value value to get
Throws:
PageException

get

Object get(PageContext pc,
           Object coll,
           String key)
           throws PageException
return a property from the given Object, when property doesn't exists throw exception

Parameters:
pc -
coll - Collection to check
key - to get from Collection
Returns:
value value to get
Throws:
PageException

set

Object set(PageContext pc,
           Object coll,
           String key,
           Object value)
           throws PageException
sets a value to the Object

Parameters:
pc -
coll - Collection to check
key - to get from Collection
value - Value to set
Returns:
value setted
Throws:
PageException

setEL

Object setEL(PageContext pc,
             Object coll,
             String key,
             Object value)
sets a value to the Object

Parameters:
pc -
coll - Collection to check
key - to get from Collection
value - Value to set
Returns:
value setted or null if can't set

removeEL

Object removeEL(Object coll,
                String key)
remove value from Collection

Parameters:
coll -
key -
Returns:
has cleared or not

remove

Object remove(Object coll,
              String key)
              throws PageException
clear value from Collection

Parameters:
coll -
key -
Returns:
has cleared or not
Throws:
PageException

callFunction

Object callFunction(PageContext pc,
                    Object coll,
                    String key,
                    Object[] args)
                    throws PageException
call a Function (UDF, Method) with or witout named values

Parameters:
pc -
coll - Collection of the UDF Function
key - name of the function
args - arguments to call the function
Returns:
return value of the function
Throws:
PageException

callFunctionWithoutNamedValues

Object callFunctionWithoutNamedValues(PageContext pc,
                                      Object coll,
                                      String key,
                                      Object[] args)
                                      throws PageException
call a Function (UDF, Method) without Named Values

Parameters:
pc -
coll - Collection of the UDF Function
key - name of the function
args - arguments to call the function
Returns:
return value of the function
Throws:
PageException

callFunctionWithNamedValues

Object callFunctionWithNamedValues(PageContext pc,
                                   Object coll,
                                   String key,
                                   Object[] args)
                                   throws PageException
call a Function (UDF, Method) with Named Values

Parameters:
pc -
coll - Collection of the UDF Function
key - name of the function
args - arguments to call the function
Returns:
return value of the function
Throws:
PageException


Copyright © 2012 Railo