railo.runtime.type.ref
Interface Reference

All Known Subinterfaces:
QueryColumn, QueryColumnPro
All Known Implementing Classes:
DebugQueryColumn, NativeReference, QueryCacheQueryColumn, QueryColumnImpl, QueryColumnRef, ReferenceReference, SimpleQueryColumn, SimpleVarRef, SVArray, SVStruct, VariableReference

public interface Reference


Method Summary
 Object get(PageContext pc)
           
 Object get(PageContext pc, Object defaultValue)
           
 Collection.Key getKey()
           
 String getKeyAsString()
          Deprecated. use instead getKey()
 Object getParent()
           
 Object remove(PageContext pc)
          clears the variable from collection
 Object removeEL(PageContext pc)
          clears the variable from collection
 Object set(PageContext pc, Object value)
           
 Object setEL(PageContext pc, Object value)
           
 Object touch(PageContext pc)
          create it when not exists
 Object touchEL(PageContext pc)
          create it when not exists
 

Method Detail

getKeyAsString

String getKeyAsString()
                      throws PageException
Deprecated. use instead getKey()

Returns:
returns the value of the Variable
Throws:
PageException

getKey

Collection.Key getKey()
                      throws PageException
Returns:
returns the value of the Variable
Throws:
PageException

get

Object get(PageContext pc)
           throws PageException
Parameters:
pc - PageContext of the actuell Request
Returns:
returns the value of the Variable
Throws:
PageException

get

Object get(PageContext pc,
           Object defaultValue)
Parameters:
pc - PageContext of the actuell Request
Returns:
returns the value of the Variable
Throws:
PageException

set

Object set(PageContext pc,
           Object value)
           throws PageException
Parameters:
pc - PageContext of the actuell Request
value - resets the value of the variable
Returns:
new Value setted
Throws:
PageException

setEL

Object setEL(PageContext pc,
             Object value)
Parameters:
pc - PageContext of the actuell Request
value - resets the value of the variable
Returns:
new Value setted
Throws:
PageException

remove

Object remove(PageContext pc)
              throws PageException
clears the variable from collection

Parameters:
pc -
Returns:
removed Object
Throws:
PageException

removeEL

Object removeEL(PageContext pc)
clears the variable from collection

Parameters:
pc -
Returns:
removed Object
Throws:
PageException

touch

Object touch(PageContext pc)
             throws PageException
create it when not exists

Parameters:
pc -
Returns:
removed Object
Throws:
PageException

touchEL

Object touchEL(PageContext pc)
create it when not exists

Parameters:
pc -
Returns:
removed Object
Throws:
PageException

getParent

Object getParent()
Returns:
returns the collection


Copyright © 2012 Railo