railo.runtime.type.scope
Interface Undefined

All Superinterfaces:
Castable, Cloneable, Collection, Dumpable, ForEachIteratorable, Iteratorable, Map, Objects, Scope, Serializable, Sizeable, Struct
All Known Implementing Classes:
UndefinedImpl

public interface Undefined
extends Scope

interface of the cope undefined


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 int MODE_LOCAL_OR_ARGUMENTS_ALWAYS
           
static int MODE_LOCAL_OR_ARGUMENTS_ONLY_WHEN_EXISTS
           
static int MODE_NO_LOCAL_AND_ARGUMENTS
           
 
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
 void addQuery(Query qry)
          add a collection to the undefined scope
 Argument argumentsScope()
           
 Object getCascading(Collection.Key key)
          gets a key from all cascaded scopes, but not from variables scope
 Object getCascading(String key)
          Deprecated. use instead getCascading(railo.runtime.type.Collection.Key)
 boolean getCheckArguments()
           
 Object getCollection(Collection.Key key)
          return value matching key, if value is from Query return a QueryColumn
 Object getCollection(String key)
          Deprecated. use instead getCollection(railo.runtime.type.Collection.Key)
 boolean getLocalAlways()
           
 QueryStack getQueryStack()
           
 Struct getScope(Collection.Key key)
           
 List<String> getScopeNames()
           
 Local localScope()
           
 void reinitialize(PageContext pc)
           
 void removeQuery()
          remove a collection from the undefined scope
 boolean setAllowImplicidQueryCall(boolean allowImplicidQueryCall)
           
 void setFunctionScopes(Local local, Argument argument)
          sets the functions scopes
 int setMode(int mode)
          sets mode of scope
 void setQueryStack(QueryStack qryStack)
          sets a individual query stack to the undefined scope
 void setVariableScope(Variables scope)
          change the variable scope
 Variables variablesScope()
           
 
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
 

Field Detail

MODE_NO_LOCAL_AND_ARGUMENTS

static final int MODE_NO_LOCAL_AND_ARGUMENTS
See Also:
Constant Field Values

MODE_LOCAL_OR_ARGUMENTS_ONLY_WHEN_EXISTS

static final int MODE_LOCAL_OR_ARGUMENTS_ONLY_WHEN_EXISTS
See Also:
Constant Field Values

MODE_LOCAL_OR_ARGUMENTS_ALWAYS

static final int MODE_LOCAL_OR_ARGUMENTS_ALWAYS
See Also:
Constant Field Values
Method Detail

localScope

Local localScope()
Returns:
returns the current local scope defined in the undefined scope

argumentsScope

Argument argumentsScope()

variablesScope

Variables variablesScope()

setMode

int setMode(int mode)
sets mode of scope

Parameters:
mode - new mode
Returns:
old mode

getLocalAlways

boolean getLocalAlways()

setFunctionScopes

void setFunctionScopes(Local local,
                       Argument argument)
sets the functions scopes

Parameters:
local - local scope
argument - argument scope

getQueryStack

QueryStack getQueryStack()
Returns:
returns actuell collection stack

setQueryStack

void setQueryStack(QueryStack qryStack)
sets a individual query stack to the undefined scope

Parameters:
qryStack - Query stack

addQuery

void addQuery(Query qry)
add a collection to the undefined scope

Parameters:
qry - Query to add to undefined scope

removeQuery

void removeQuery()
remove a collection from the undefined scope


getCollection

Object getCollection(String key)
                     throws PageException
Deprecated. use instead getCollection(railo.runtime.type.Collection.Key)

return value matching key, if value is from Query return a QueryColumn

Parameters:
key -
Returns:
return matched value
Throws:
PageException

getScopeNames

List<String> getScopeNames()

getCollection

Object getCollection(Collection.Key key)
                     throws PageException
return value matching key, if value is from Query return a QueryColumn

Parameters:
key -
Returns:
return matched value
Throws:
PageException

getCascading

Object getCascading(String key)
Deprecated. use instead getCascading(railo.runtime.type.Collection.Key)

gets a key from all cascaded scopes, but not from variables scope

Parameters:
key - key to get
Returns:
matching value or null

getCascading

Object getCascading(Collection.Key key)
gets a key from all cascaded scopes, but not from variables scope

Parameters:
key - key to get
Returns:
matching value or null

setVariableScope

void setVariableScope(Variables scope)
change the variable scope

Parameters:
scope -

getCheckArguments

boolean getCheckArguments()
Returns:
if check for arguments and local scope values

getScope

Struct getScope(Collection.Key key)

setAllowImplicidQueryCall

boolean setAllowImplicidQueryCall(boolean allowImplicidQueryCall)

reinitialize

void reinitialize(PageContext pc)


Copyright © 2012 Railo