railo.runtime.type.scope
Interface Argument

All Superinterfaces:
Array, BindScope, Castable, Cloneable, Collection, Dumpable, ForEachIteratorable, Iteratorable, Map, Objects, Scope, Serializable, Sizeable, Struct
All Known Implementing Classes:
ArgumentImpl, ArgumentThreadImpl

public interface Argument
extends Scope, Array, BindScope

interface for Argument scope


Nested Class Summary
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
static Object NULL
           
 
Fields inherited from interface railo.runtime.type.scope.Scope
SCOPE_APPLICATION, SCOPE_ARGUMENTS, SCOPE_CALLER, SCOPE_CGI, SCOPE_CLIENT, SCOPE_CLUSTER, SCOPE_COOKIE, SCOPE_COUNT, SCOPE_FORM, SCOPE_LOCAL, SCOPE_REQUEST, SCOPE_SERVER, SCOPE_SESSION, SCOPE_UNDEFINED, SCOPE_URL, SCOPE_VAR, SCOPE_VARIABLES
 
Fields inherited from interface railo.runtime.type.Struct
TYPE_LINKED, TYPE_REGULAR, TYPE_SOFT, TYPE_SYNC, TYPE_WEAKED
 
Method Summary
 boolean containsFunctionArgumentKey(Collection.Key key)
           
 Object getFunctionArgument(Collection.Key key, Object defaultValue)
           
 Object getFunctionArgument(String key, Object defaultValue)
           
 boolean insert(int index, String key, Object value)
          insert a key in argument scope at defined position
 boolean isBind()
           
 Object setArgument(Object obj)
           
 void setBind(boolean bind)
          sets if scope is binded to a other variable for using outside of a udf
 void setFunctionArgumentNames(Set functionArgumentNames)
           
 
Methods inherited from interface railo.runtime.type.scope.Scope
getType, getTypeAsString, initialize, isInitalized, release, release
 
Methods inherited from interface railo.runtime.type.Collection
clear, clone, containsKey, containsKey, duplicate, get, get, get, get, keys, remove, removeEL, set, set, setEL, setEL, size
 
Methods inherited from interface railo.runtime.type.Iteratorable
entryIterator, keyIterator, keysAsStringIterator, valueIterator
 
Methods inherited from interface railo.runtime.type.ForEachIteratorable
getIterator
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from interface railo.runtime.type.Sizeable
sizeOf
 
Methods inherited from interface railo.runtime.type.Objects
call, callWithNamedValues, get, get, set, setEL
 
Methods inherited from interface railo.runtime.dump.Dumpable
toDumpData
 
Methods inherited from interface railo.runtime.op.Castable
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo
 
Methods inherited from interface railo.runtime.type.Array
append, appendEL, containsKey, get, getDimension, getE, insert, intKeys, prepend, removeE, removeEL, resize, setE, setEL, sort, sort, toArray, toList
 

Field Detail

NULL

static final Object NULL
Method Detail

setBind

void setBind(boolean bind)
sets if scope is binded to a other variable for using outside of a udf

Specified by:
setBind in interface BindScope
Parameters:
bind -

isBind

boolean isBind()
Specified by:
isBind in interface BindScope
Returns:
returns if scope is binded to a other variable for using outside of a udf

insert

boolean insert(int index,
               String key,
               Object value)
               throws PageException
insert a key in argument scope at defined position

Parameters:
index -
key -
value -
Returns:
boolean
Throws:
PageException

setArgument

Object setArgument(Object obj)
                   throws PageException
Throws:
PageException

getFunctionArgument

Object getFunctionArgument(String key,
                           Object defaultValue)

getFunctionArgument

Object getFunctionArgument(Collection.Key key,
                           Object defaultValue)

setFunctionArgumentNames

void setFunctionArgumentNames(Set functionArgumentNames)

containsFunctionArgumentKey

boolean containsFunctionArgumentKey(Collection.Key key)


Copyright © 2012 Railo