struct
ARGUMENTS
struct
EVENT
component model.myRequestContext
        extends coldbox.system.web.context.requestContextDecorator
METHODS
$DUMP
function $dump
Arguments:
Name Required Type Default
var Required any  
isAbort Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Facade for cfmx dump
Description:  
$THROW
function $throw
Arguments:
Name Required Type Default
message Required string  
detail Optional string [empty string]
type Optional string Framework
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Facade for cfthrow
Description:  
BUILDLINK
function buildLink
Arguments:
Name Required Type Default
linkto Required string  
translate Optional boolean true
ssl Optional boolean false
baseURL Optional string [empty string]
queryString Optional string [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Builds a link to a passed event, either SES or normal link. If the ses interceptor is declared it will create routes.
Description:  
CLEARCOLLECTION
function clearCollection
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Clears the entire collection
Description:  
COLLECTIONAPPEND
function collectionAppend
Arguments:
Name Required Type Default
collection Required any  
overwrite Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Append a structure to the collection, with overwrite or not. Overwrite = false by default
Description:  
CONFIGURE
function configure
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override to provide a pseudo-constructor for your decorator
Description:  
GETCOLLECTION
function getCollection
Arguments:
Name Required Type Default
deepCopyFlag Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a reference or deep copy of the public or private request Collection
Description:  
GETCONTROLLER
function getController
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Get controller: coldbox.system.web.Controller
Description:  
GETCURRENTACTION
function getCurrentAction
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current action requested in the current event: String
Description:  
GETCURRENTEVENT
function getCurrentEvent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current incoming event
Description:  
GETCURRENTHANDLER
function getCurrentHandler
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current handler requested in the current event: String
Description:  
GETCURRENTLAYOUT
function getCurrentLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout for rendering
Description:  
GETCURRENTLAYOUTMODULE
function getCurrentLayoutModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout's module for rendering
Description:  
GETCURRENTMODULE
function getCurrentModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current module name, else returns empty string
Description:  
GETCURRENTROUTE
function getCurrentRoute
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current request's SES route that matched
Description:  
GETCURRENTROUTEDNAMESPACE
function getCurrentRoutedNamespace
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed namespace that matched the SES route, if any
Description:  
GETCURRENTROUTEDURL
function getCurrentRoutedURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed URL that matched the SES route
Description:  
GETCURRENTVIEW
function getCurrentView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWARGS
function getCurrentViewArgs
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWMODULE
function getCurrentViewModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set views's module for rendering
Description:  
GETDEBUGPANELFLAG
function getDebugPanelFlag
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I return the debugpanel flag for this request.
Description:  
GETDEFAULTLAYOUT
function getDefaultLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default layout of the application: String
Description:  
GETDEFAULTVIEW
function getDefaultView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default view of the application: String
Description:  
GETEVENTCACHEABLEENTRY
function getEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETEVENTNAME
function getEventName
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: The event name used by the application: String
Description:  
GETFOLDERLAYOUTS
function getFolderLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered folder layout associations map
Description:  
GETHTTPBASICCREDENTIALS
function getHTTPBasicCredentials
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the username and password sent via HTTP basic authentication
Description:  
GETHTTPCONTENT
function getHTTPContent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the raw HTTP content
Description:  
GETHTTPHEADER
function getHTTPHeader
Arguments:
Name Required Type Default
header Required string  
default Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a HTTP header
Description:  
GETHTTPMETHOD
function getHTTPMethod
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the HTTP Request Method Type
Description:  
GETMEMENTO
function getMemento
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the state of this request context
Description:  
GETMODULEROOT
function getModuleRoot
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Convenience method to get the current request's module root path. If no module, then returns empty path. You can also get this from the modules settings.
Description:  
GETREGISTEREDLAYOUTS
function getRegisteredLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get all the registered layouts in the configuration file
Description:  
GETRENDERDATA
function getRenderData
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the renderData structure.
Description:  
GETREQUESTCONTEXT
function getRequestContext
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the original request context. coldbox.system.web.context.RequestContext
Description:  
GETROUTEDSTRUCT
function getRoutedStruct
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the routed structure of key-value pairs. What the ses interceptor could match.
Description:  
GETSELF
function getSelf
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns index.cfm?{eventName}= : String
Description:  
GETSESBASEURL
function getSESBaseURL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the ses base URL for this request
Description:  
GETSIZE
function getSize
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: numeric
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the number of elements in the collection
Description:  
GETTRIMVALUE
function getTrimValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional boolean false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the request collection and if simple value, I will trim it.
Description:  
GETVALUE
function getValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional any false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the public or private request collection.
Description:  
GETVIEWCACHEABLEENTRY
function getViewCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETVIEWLAYOUTS
function getViewLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered view layout associations map
Description:  
INIT
function init
Arguments:
Name Required Type Default
oContext Required any  
controller Required any  
ReturnType: RequestContextDecorator
Roles:  
Access: public
Output: false
DisplayName:  
Hint: constructor
Description:  
ISAJAX
function isAjax
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determines if in an Ajax call or not by looking at the request headers
Description:  
ISEVENTCACHEABLE
function isEventCacheable
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming event has been flagged for caching. Boolean
Description:  
ISNOEXECUTION
function isNoExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if we need to execute an incoming event or not.
Description:  
ISNORENDER
function isNoRender
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a no render request
Description:  
ISPROXYREQUEST
function isProxyRequest
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a coldbox proxy request
Description:  
ISSES
function isSES
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if you are in SES mode.
Description:  
ISSSL
function isSSL
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns boolean result whether current request is in ssl or not
Description:  
ISVIEWCACHEABLE
function isViewCacheable
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming view has been flagged for caching
Description:  
NOEXECUTION
function noExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that the request will not execute an incoming event. Most likely simulating a servlet call.
Description:  
NOLAYOUT
function noLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Mark this request to not use a layout for rendering
Description:  
NORENDER
function noRender
Arguments:
Name Required Type Default
remove Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the flag that tells the framework not to render, just execute
Description:  
OVERRIDEEVENT
function overrideEvent
Arguments:
Name Required Type Default
event Optional Any  
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Override the current event in the request collection. This method does not execute the event, it just replaces the event to be executed by the framework's RunEvent() method. This method is usually called from an onRequestStart or onApplicationStart method.
Description:  
PARAMVALUE
function paramValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: Just like cfparam, but for the request collection
Description:  
REMOVEEVENTCACHEABLEENTRY
function removeEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Remove the cacheable entry
Description:  
REMOVEVALUE
function removeValue
Arguments:
Name Required Type Default
name Required string  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I remove a value in the request collection
Description:  
RENDERDATA
function renderData
Arguments:
Name Required Type Default
type Optional string HTML
data Required any  
contentType Required string [empty string]
encoding Optional string utf-8
statusCode Optional numeric 200
statusText Optional string [empty string]
location Optional string [empty string]
jsonCallback Optional string [empty string]
jsonQueryFormat Optional string query
jsonAsText Optional boolean false
xmlColumnList Optional string [empty string]
xmlUseCDATA Optional boolean false
xmlListDelimiter Optional string ,
xmlRootName Optional string [empty string]
pdfArgs Optional struct [runtime expression]
formats Optional any [empty string]
formatsView Optional any [empty string]
isBinary Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Use this method to tell the framework to render data for you. The framework will take care of marshalling the data for you
Description:  
RENDERWITHFORMATS
function renderWithFormats
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Render With Formats
Description:  
SETDEFAULTLAYOUT
function setDefaultLayout
Arguments:
Name Required Type Default
DefaultLayout Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default layout for a request
Description:  
SETDEFAULTVIEW
function setDefaultView
Arguments:
Name Required Type Default
DefaultView Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default view for a request
Description:  
SETEVENTCACHEABLEENTRY
function setEventCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the event cacheable entry
Description:  
SETHTTPHEADER
function setHTTPHeader
Arguments:
Name Required Type Default
statusCode Optional string  
statusText Optional string [empty string]
name Optional string  
value Optional string [empty string]
charset Optional string UTF-8
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set an HTTP Header
Description:  
SETISSES
function setisSES
Arguments:
Name Required Type Default
isSES Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the isSES flag, usualy done by the SES interceptor
Description:  
SETLAYOUT
function setLayout
Arguments:
Name Required Type Default
name Required Any  
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the layout to override and render. Layouts are pre-defined in the config file. However I can override these settings if needed. Do not append a the cfm extension. Private Request Collection name: currentLayout
Description:  
SETMEMENTO
function setMemento
Arguments:
Name Required Type Default
memento Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the state of this request context
Description:  
SETPROXYREQUEST
function setProxyRequest
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that this is a proxy request
Description:  
SETREQUESTCONTEXT
function setRequestContext
Arguments:
Name Required Type Default
requestContext Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: DO NOT OVERRIDE: Set the original request context.
Description:  
SETROUTEDSTRUCT
function setRoutedStruct
Arguments:
Name Required Type Default
routedStruct Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set routed struct of key-value pairs. This is used only by the SES interceptor. Not for public use.
Description:  
SETSESBASEURL
function setSESBaseURL
Arguments:
Name Required Type Default
sesBaseURL Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the ses base URL for this request
Description:  
SETVALUE
function setValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Set a value in the request collection
Description:  
SETVIEW
function setView
Arguments:
Name Required Type Default
view Optional any  
nolayout Optional boolean false
cache Optional boolean false
cacheTimeout Optional any [empty string]
cacheLastAccessTimeout Optional any [empty string]
cacheSuffix Optional any [empty string]
cacheProvider Optional any template
layout Optional any  
module Optional any [empty string]
args Optional struct [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the view to render in this request. Private Request Collection Name: currentView, currentLayout
Description:  
SETVIEWCACHEABLEENTRY
function setViewCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the view cacheable entry
Description:  
SHOWDEBUGPANEL
function showDebugPanel
Arguments:
Name Required Type Default
show Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I can override to show or not the debug panel. Very useful in AJAX debugging
Description:  
VALUEEXISTS
function valueExists
Arguments:
Name Required Type Default
name Required any  
private Optional boolean false
ReturnType: boolean
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Check if a value exists in the request collection.
Description:  
PRC
struct
MYPRCVAR ok
cbox_incomingContextHash 99914B932BD37A50B983C5E7C90AE93B
RC
struct
event home.main
MYBEAN
component model.testBean
$MIXED true
PROPERTIES
firstName Gus
lastName Allison
myvar last
METHODS
$DUMP
function $dump
Arguments:
Name Required Type Default
var Required any  
isAbort Optional boolean false
ReturnType: void
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Facade for cfmx dump
Description:  
$THROW
function $throw
Arguments:
Name Required Type Default
message Required string  
detail Optional string [empty string]
type Optional string Framework
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Facade for cfthrow
Description:  
BUILDLINK
function buildLink
Arguments:
Name Required Type Default
linkto Required string  
translate Optional boolean true
ssl Optional boolean false
baseURL Optional string [empty string]
queryString Optional string [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Builds a link to a passed event, either SES or normal link. If the ses interceptor is declared it will create routes.
Description:  
CLEARCOLLECTION
function clearCollection
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Clears the entire collection
Description:  
COLLECTIONAPPEND
function collectionAppend
Arguments:
Name Required Type Default
collection Required any  
overwrite Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Append a structure to the collection, with overwrite or not. Overwrite = false by default
Description:  
CONFIGURE
function configure
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override to provide a pseudo-constructor for your decorator
Description:  
EXPOSEMIXIN
function exposeMixin
Arguments:
Name Required Type Default
method Required Any  
newName Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Exposes a private function publicly
Description:  
GETCOLLECTION
function getCollection
Arguments:
Name Required Type Default
deepCopyFlag Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a reference or deep copy of the public or private request Collection
Description:  
GETCONTROLLER
function getController
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Get controller: coldbox.system.web.Controller
Description:  
GETCURRENTACTION
function getCurrentAction
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current action requested in the current event: String
Description:  
GETCURRENTEVENT
function getCurrentEvent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current incoming event
Description:  
GETCURRENTHANDLER
function getCurrentHandler
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current handler requested in the current event: String
Description:  
GETCURRENTLAYOUT
function getCurrentLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout for rendering
Description:  
GETCURRENTLAYOUTMODULE
function getCurrentLayoutModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout's module for rendering
Description:  
GETCURRENTMODULE
function getCurrentModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current module name, else returns empty string
Description:  
GETCURRENTROUTE
function getCurrentRoute
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current request's SES route that matched
Description:  
GETCURRENTROUTEDNAMESPACE
function getCurrentRoutedNamespace
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed namespace that matched the SES route, if any
Description:  
GETCURRENTROUTEDURL
function getCurrentRoutedURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed URL that matched the SES route
Description:  
GETCURRENTVIEW
function getCurrentView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWARGS
function getCurrentViewArgs
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWMODULE
function getCurrentViewModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set views's module for rendering
Description:  
GETDEBUGPANELFLAG
function getDebugPanelFlag
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I return the debugpanel flag for this request.
Description:  
GETDEFAULTLAYOUT
function getDefaultLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default layout of the application: String
Description:  
GETDEFAULTVIEW
function getDefaultView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default view of the application: String
Description:  
GETEVENTCACHEABLEENTRY
function getEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETEVENTNAME
function getEventName
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: The event name used by the application: String
Description:  
GETFIRSTNAME
function GETFIRSTNAME
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFOLDERLAYOUTS
function getFolderLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered folder layout associations map
Description:  
GETHTTPBASICCREDENTIALS
function getHTTPBasicCredentials
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the username and password sent via HTTP basic authentication
Description:  
GETHTTPCONTENT
function getHTTPContent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the raw HTTP content
Description:  
GETHTTPHEADER
function getHTTPHeader
Arguments:
Name Required Type Default
header Required string  
default Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a HTTP header
Description:  
GETHTTPMETHOD
function getHTTPMethod
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the HTTP Request Method Type
Description:  
GETLASTNAME
function GETLASTNAME
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMEMENTO
function getMemento
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the state of this request context
Description:  
GETMODULEROOT
function getModuleRoot
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Convenience method to get the current request's module root path. If no module, then returns empty path. You can also get this from the modules settings.
Description:  
GETMYVAR
function GETMYVAR
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPROPERTYMIXIN
function getPropertyMixin
Arguments:
Name Required Type Default
name Required Any  
scope Optional Any variables
default Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: gets a property
Description:  
GETREGISTEREDLAYOUTS
function getRegisteredLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get all the registered layouts in the configuration file
Description:  
GETRENDERDATA
function getRenderData
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the renderData structure.
Description:  
GETREQUESTCONTEXT
function getRequestContext
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the original request context. coldbox.system.web.context.RequestContext
Description:  
GETROUTEDSTRUCT
function getRoutedStruct
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the routed structure of key-value pairs. What the ses interceptor could match.
Description:  
GETSELF
function getSelf
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns index.cfm?{eventName}= : String
Description:  
GETSESBASEURL
function getSESBaseURL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the ses base URL for this request
Description:  
GETSIZE
function getSize
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: numeric
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the number of elements in the collection
Description:  
GETTRIMVALUE
function getTrimValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional boolean false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the request collection and if simple value, I will trim it.
Description:  
GETVALUE
function getValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional any false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the public or private request collection.
Description:  
GETVIEWCACHEABLEENTRY
function getViewCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETVIEWLAYOUTS
function getViewLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered view layout associations map
Description:  
INCLUDEITMIXIN
function includeitMixin
Arguments:
Name Required Type Default
template Required Any  
ReturnType: void
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Facade for cfinclude
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INJECTMIXIN
function injectMixin
Arguments:
Name Required Type Default
name Required Any  
UDF Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Injects a method into the CFC
Description:  
INJECTPROPERTYMIXIN
function injectPropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
propertyValue Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: injects a property into the passed scope
Description:  
INVOKERMIXIN
function invokerMixin
Arguments:
Name Required Type Default
method Required Any  
argCollection Optional Any  
argList Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Calls private/packaged/public methods
Description:  
ISAJAX
function isAjax
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determines if in an Ajax call or not by looking at the request headers
Description:  
ISEVENTCACHEABLE
function isEventCacheable
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming event has been flagged for caching. Boolean
Description:  
ISNOEXECUTION
function isNoExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if we need to execute an incoming event or not.
Description:  
ISNORENDER
function isNoRender
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a no render request
Description:  
ISPROXYREQUEST
function isProxyRequest
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a coldbox proxy request
Description:  
ISSES
function isSES
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if you are in SES mode.
Description:  
ISSSL
function isSSL
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns boolean result whether current request is in ssl or not
Description:  
ISVIEWCACHEABLE
function isViewCacheable
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming view has been flagged for caching
Description:  
METHODPROXY
function methodProxy
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: a method proxy
Description:  
NOEXECUTION
function noExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that the request will not execute an incoming event. Most likely simulating a servlet call.
Description:  
NOLAYOUT
function noLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Mark this request to not use a layout for rendering
Description:  
NORENDER
function noRender
Arguments:
Name Required Type Default
remove Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the flag that tells the framework not to render, just execute
Description:  
OVERRIDEEVENT
function overrideEvent
Arguments:
Name Required Type Default
event Optional Any  
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Override the current event in the request collection. This method does not execute the event, it just replaces the event to be executed by the framework's RunEvent() method. This method is usually called from an onRequestStart or onApplicationStart method.
Description:  
PARAMVALUE
function paramValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: Just like cfparam, but for the request collection
Description:  
POPULATEPROPERTYMIXIN
function populatePropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
propertyValue Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Populates a property if it exists
Description:  
REMOVEEVENTCACHEABLEENTRY
function removeEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Remove the cacheable entry
Description:  
REMOVEMIXIN
function removeMixin
Arguments:
Name Required Type Default
UDFName Required string  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Removes a method in a CFC
Description:  
REMOVEPROPERTYMIXIN
function removePropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: removes a property from the cfc used.
Description:  
REMOVEVALUE
function removeValue
Arguments:
Name Required Type Default
name Required string  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I remove a value in the request collection
Description:  
RENDERDATA
function renderData
Arguments:
Name Required Type Default
type Optional string HTML
data Required any  
contentType Required string [empty string]
encoding Optional string utf-8
statusCode Optional numeric 200
statusText Optional string [empty string]
location Optional string [empty string]
jsonCallback Optional string [empty string]
jsonQueryFormat Optional string query
jsonAsText Optional boolean false
xmlColumnList Optional string [empty string]
xmlUseCDATA Optional boolean false
xmlListDelimiter Optional string ,
xmlRootName Optional string [empty string]
pdfArgs Optional struct [runtime expression]
formats Optional any [empty string]
formatsView Optional any [empty string]
isBinary Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Use this method to tell the framework to render data for you. The framework will take care of marshalling the data for you
Description:  
RENDERWITHFORMATS
function renderWithFormats
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Render With Formats
Description:  
SETDEFAULTLAYOUT
function setDefaultLayout
Arguments:
Name Required Type Default
DefaultLayout Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default layout for a request
Description:  
SETDEFAULTVIEW
function setDefaultView
Arguments:
Name Required Type Default
DefaultView Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default view for a request
Description:  
SETEVENTCACHEABLEENTRY
function setEventCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the event cacheable entry
Description:  
SETFIRSTNAME
function SETFIRSTNAME
Arguments:
Name Required Type Default
firstName Required string  
ReturnType: model.testBean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETHTTPHEADER
function setHTTPHeader
Arguments:
Name Required Type Default
statusCode Optional string  
statusText Optional string [empty string]
name Optional string  
value Optional string [empty string]
charset Optional string UTF-8
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set an HTTP Header
Description:  
SETISSES
function setisSES
Arguments:
Name Required Type Default
isSES Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the isSES flag, usualy done by the SES interceptor
Description:  
SETLASTNAME
function SETLASTNAME
Arguments:
Name Required Type Default
lastName Required string  
ReturnType: model.testBean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLAYOUT
function setLayout
Arguments:
Name Required Type Default
name Required Any  
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the layout to override and render. Layouts are pre-defined in the config file. However I can override these settings if needed. Do not append a the cfm extension. Private Request Collection name: currentLayout
Description:  
SETMEMENTO
function setMemento
Arguments:
Name Required Type Default
memento Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the state of this request context
Description:  
SETMYVAR
function SETMYVAR
Arguments:
Name Required Type Default
myvar Required string  
ReturnType: model.testBean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPROXYREQUEST
function setProxyRequest
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that this is a proxy request
Description:  
SETREQUESTCONTEXT
function setRequestContext
Arguments:
Name Required Type Default
requestContext Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: DO NOT OVERRIDE: Set the original request context.
Description:  
SETROUTEDSTRUCT
function setRoutedStruct
Arguments:
Name Required Type Default
routedStruct Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set routed struct of key-value pairs. This is used only by the SES interceptor. Not for public use.
Description:  
SETSESBASEURL
function setSESBaseURL
Arguments:
Name Required Type Default
sesBaseURL Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the ses base URL for this request
Description:  
SETVALUE
function setValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Set a value in the request collection
Description:  
SETVIEW
function setView
Arguments:
Name Required Type Default
view Optional any  
nolayout Optional boolean false
cache Optional boolean false
cacheTimeout Optional any [empty string]
cacheLastAccessTimeout Optional any [empty string]
cacheSuffix Optional any [empty string]
cacheProvider Optional any template
layout Optional any  
module Optional any [empty string]
args Optional struct [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the view to render in this request. Private Request Collection Name: currentView, currentLayout
Description:  
SETVIEWCACHEABLEENTRY
function setViewCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the view cacheable entry
Description:  
SHOWDEBUGPANEL
function showDebugPanel
Arguments:
Name Required Type Default
show Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I can override to show or not the debug panel. Very useful in AJAX debugging
Description:  
VALUEEXISTS
function valueExists
Arguments:
Name Required Type Default
name Required any  
private Optional boolean false
ReturnType: boolean
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Check if a value exists in the request collection.
Description:  
THIS
component handlers.home
PREHANDLER_ONLY [empty string]
EVENT_CACHE_SUFFIX [empty string]
$SUPER
component coldbox.system.EventHandler
        extends coldbox.system.FrameworkSupertype
PREHANDLER_EXCEPT [empty string]
PREHANDLER_ONLY [empty string]
$MIXED true
ALLOWEDMETHODS
struct [empty]
POSTHANDLER_ONLY [empty string]
POSTHANDLER_EXCEPT [empty string]
AROUNDHANDLER_ONLY [empty string]
EVENT_CACHE_SUFFIX [empty string]
AROUNDHANDLER_EXCEPT [empty string]
METHODS
$ABORT
function $abort
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade for cfabort
Description:  
$DUMP
function $dump
Arguments:
Name Required Type Default
var Required any  
isAbort Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Facade for cfmx dump
Description:  
$HTMLHEAD
function $htmlhead
Arguments:
Name Required Type Default
content Required string  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to cfhtmlhead
Description:  
$INCLUDE
function $include
Arguments:
Name Required Type Default
template Optional string  
ReturnType: void
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Facade for cfinclude
Description:  
$RETHROW
function $rethrow
Arguments:
Name Required Type Default
throwObject Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Rethrow facade
Description:  
$THROW
function $throw
Arguments:
Name Required Type Default
message Required string  
detail Optional string [empty string]
type Optional string Framework
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade for cfthrow
Description:  
_ACTIONEXISTS
function _actionExists
Arguments:
Name Required Type Default
action Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Checks if an action is defined, either public or private
Description:  
_PRIVATEINVOKER
function _privateInvoker
Arguments:
Name Required Type Default
method Required Any  
argCollection Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: calls private/packaged/public methods. Used internally by coldbox to execute private events
Description:  
ADDASSET
function addAsset
Arguments:
Name Required Type Default
asset Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Add a js/css asset(s) to the html head section. You can also pass in a list of assets.
Description:  
ANNOUNCEINTERCEPTION
function announceInterception
Arguments:
Name Required Type Default
state Required any  
interceptData Optional any  
async Optional boolean false
asyncAll Optional boolean false
asyncAllJoin Optional boolean true
asyncPriority Optional string NORMAL
asyncJoinTimeout Optional numeric 0
ReturnType: any
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Announce an interception to the system. If you use the asynchronous facilities, you will get a thread structure report as a result.
Description:  
BUILDLINK
function buildLink
Arguments:
Name Required Type Default
linkto Required string  
translate Optional boolean true
ssl Optional boolean false
baseURL Optional string [empty string]
queryString Optional string [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Builds a link to a passed event, either SES or normal link. If the ses interceptor is declared it will create routes.
Description:  
CLEARCOLLECTION
function clearCollection
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Clears the entire collection
Description:  
COLLECTIONAPPEND
function collectionAppend
Arguments:
Name Required Type Default
collection Required any  
overwrite Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Append a structure to the collection, with overwrite or not. Overwrite = false by default
Description:  
CONFIGURE
function configure
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override to provide a pseudo-constructor for your decorator
Description:  
EXPOSEMIXIN
function exposeMixin
Arguments:
Name Required Type Default
method Required Any  
newName Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Exposes a private function publicly
Description:  
GETCOLDBOXOCM
function getColdboxOCM
Arguments:
Name Required Type Default
cacheName Optional any default
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a CacheBox Cache of type: coldbox.system.cache.IColdboxApplicationCache
Description:  
GETCOLLECTION
function getCollection
Arguments:
Name Required Type Default
deepCopyFlag Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a reference or deep copy of the public or private request Collection
Description:  
GETCONTROLLER
function getController
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get controller: coldbox.system.web.Controller
Description:  
GETCURRENTACTION
function getCurrentAction
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current action requested in the current event: String
Description:  
GETCURRENTEVENT
function getCurrentEvent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current incoming event
Description:  
GETCURRENTHANDLER
function getCurrentHandler
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current handler requested in the current event: String
Description:  
GETCURRENTLAYOUT
function getCurrentLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout for rendering
Description:  
GETCURRENTLAYOUTMODULE
function getCurrentLayoutModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout's module for rendering
Description:  
GETCURRENTMODULE
function getCurrentModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current module name, else returns empty string
Description:  
GETCURRENTROUTE
function getCurrentRoute
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current request's SES route that matched
Description:  
GETCURRENTROUTEDNAMESPACE
function getCurrentRoutedNamespace
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed namespace that matched the SES route, if any
Description:  
GETCURRENTROUTEDURL
function getCurrentRoutedURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed URL that matched the SES route
Description:  
GETCURRENTVIEW
function getCurrentView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWARGS
function getCurrentViewArgs
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWMODULE
function getCurrentViewModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set views's module for rendering
Description:  
GETDATASOURCE
function getDatasource
Arguments:
Name Required Type Default
alias Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I will return to you a datasourceBean according to the alias of the datasource you wish to get from the configstruct
Description:  
GETDEBUGMODE
function getDebugMode
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to get your current debug mode
Description:  
GETDEBUGPANELFLAG
function getDebugPanelFlag
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I return the debugpanel flag for this request.
Description:  
GETDEFAULTLAYOUT
function getDefaultLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default layout of the application: String
Description:  
GETDEFAULTVIEW
function getDefaultView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default view of the application: String
Description:  
GETEVENTCACHEABLEENTRY
function getEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETEVENTNAME
function getEventName
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: The event name used by the application: String
Description:  
GETFOLDERLAYOUTS
function getFolderLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered folder layout associations map
Description:  
GETFWLOCALE
function getfwLocale
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the user's currently set locale or default locale
Description:  
GETHTTPBASICCREDENTIALS
function getHTTPBasicCredentials
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the username and password sent via HTTP basic authentication
Description:  
GETHTTPCONTENT
function getHTTPContent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the raw HTTP content
Description:  
GETHTTPHEADER
function getHTTPHeader
Arguments:
Name Required Type Default
header Required string  
default Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a HTTP header
Description:  
GETHTTPMETHOD
function getHTTPMethod
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the HTTP Request Method Type
Description:  
GETINTERCEPTOR
function getInterceptor
Arguments:
Name Required Type Default
interceptorName Optional any  
deepSearch Optional any false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get an interceptor
Description:  
GETMAILSERVICE
function getMailService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a reference to our Mail Service plugin
Description:  
GETMAILSETTINGS
function getMailSettings
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I will return to you a mailsettingsBean modeled after your mail settings in your config file.
Description:  
GETMEMENTO
function getMemento
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the memento of this object
Description:  
GETMODEL
function getModel
Arguments:
Name Required Type Default
name Optional Any  
dsl Optional Any  
initArguments Optional Any [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Create or retrieve model objects by convention
Description:  
GETMODULEROOT
function getModuleRoot
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Convenience method to get the current request's module root path. If no module, then returns empty path. You can also get this from the modules settings.
Description:  
GETMODULESETTINGS
function getModuleSettings
Arguments:
Name Required Type Default
module Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a module's setting structure if it exists
Description:  
GETMYPLUGIN
function getMyPlugin
Arguments:
Name Required Type Default
plugin Required any  
newInstance Optional any false
module Optional any [empty string]
init Optional any true
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETNEWMAIL
function getNewMail
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a new mail payload object ready for sending email through our mail service. This function's arguments match the cfmail tag, so send whatever you like
Description:  
GETPLUGIN
function getPlugin
Arguments:
Name Required Type Default
plugin Optional any  
customPlugin Optional any false
newInstance Optional any false
module Optional any [empty string]
init Optional any true
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETPROPERTYMIXIN
function getPropertyMixin
Arguments:
Name Required Type Default
name Required Any  
scope Optional Any variables
default Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: gets a property
Description:  
GETREGISTEREDLAYOUTS
function getRegisteredLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get all the registered layouts in the configuration file
Description:  
GETRENDERDATA
function getRenderData
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the renderData structure.
Description:  
GETREQUESTCONTEXT
function getRequestContext
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the original request context. coldbox.system.web.context.RequestContext
Description:  
GETRESOURCE
function getResource
Arguments:
Name Required Type Default
resource Required any  
default Optional any  
locale Optional any  
values Optional any  
bundle Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to i18n.getResource. Returns a string.
Description:  
GETROUTEDSTRUCT
function getRoutedStruct
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the routed structure of key-value pairs. What the ses interceptor could match.
Description:  
GETSELF
function getSelf
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns index.cfm?{eventName}= : String
Description:  
GETSESBASEURL
function getSESBaseURL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the ses base URL for this request
Description:  
GETSETTING
function getSetting
Arguments:
Name Required Type Default
name Required any  
FWSetting Optional boolean false
defaultValue Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETSETTINGSBEAN
function getSettingsBean
Arguments:
Name Required Type Default
FWSetting Optional boolean false
ReturnType: coldbox.system.core.collections.ConfigBean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns a configBean with all the configuration structure.
Description:  
GETSETTINGSTRUCTURE
function getSettingStructure
Arguments:
Name Required Type Default
FWSetting Optional boolean false
DeepCopyFlag Optional boolean false
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETSIZE
function getSize
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: numeric
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the number of elements in the collection
Description:  
GETTRIMVALUE
function getTrimValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional boolean false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the request collection and if simple value, I will trim it.
Description:  
GETVALIDATIONMANAGER
function getValidationManager
Arguments:none
ReturnType: coldbox.system.validation.IValidationManager
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Retrieve the application's configured Validation Manager
Description:  
GETVALUE
function getValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional any false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the public or private request collection.
Description:  
GETVIEWCACHEABLEENTRY
function getViewCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETVIEWLAYOUTS
function getViewLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered view layout associations map
Description:  
INCLUDEITMIXIN
function includeitMixin
Arguments:
Name Required Type Default
template Required Any  
ReturnType: void
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Facade for cfinclude
Description:  
INCLUDEUDF
function includeUDF
Arguments:
Name Required Type Default
udflibrary Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Injects a UDF Library (*.cfc or *.cfm) into the target object. It does not however, put the mixins on any of the cfc scopes. Therefore they can only be called internally.
Description:  
INIT
function init
Arguments:
Name Required Type Default
controller Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: The event handler controller
Description:  
INJECTMIXIN
function injectMixin
Arguments:
Name Required Type Default
name Required Any  
UDF Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Injects a method into the CFC
Description:  
INJECTPROPERTYMIXIN
function injectPropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
propertyValue Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: injects a property into the passed scope
Description:  
INVOKERMIXIN
function invokerMixin
Arguments:
Name Required Type Default
method Required Any  
argCollection Optional Any  
argList Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Calls private/packaged/public methods
Description:  
ISAJAX
function isAjax
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determines if in an Ajax call or not by looking at the request headers
Description:  
ISEVENTCACHEABLE
function isEventCacheable
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming event has been flagged for caching. Boolean
Description:  
ISNOEXECUTION
function isNoExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if we need to execute an incoming event or not.
Description:  
ISNORENDER
function isNoRender
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a no render request
Description:  
ISPROXYREQUEST
function isProxyRequest
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a coldbox proxy request
Description:  
ISSES
function isSES
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if you are in SES mode.
Description:  
ISSSL
function isSSL
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns boolean result whether current request is in ssl or not
Description:  
ISVIEWCACHEABLE
function isViewCacheable
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming view has been flagged for caching
Description:  
LOADGLOBALUDFLIBRARIES
function loadGlobalUDFLibraries
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Load the global UDF libraries defined in the UDFLibraryFile Setting
Description:  
LOCATEDIRECTORYPATH
function locateDirectoryPath
Arguments:
Name Required Type Default
pathToCheck Required any  
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Locate the real path location of a directory in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path
Description:  
LOCATEFILEPATH
function locateFilePath
Arguments:
Name Required Type Default
pathToCheck Required any  
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Locate the real path location of a file in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path
Description:  
METHODPROXY
function methodProxy
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: a method proxy
Description:  
NOEXECUTION
function noExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that the request will not execute an incoming event. Most likely simulating a servlet call.
Description:  
NOLAYOUT
function noLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Mark this request to not use a layout for rendering
Description:  
NORENDER
function noRender
Arguments:
Name Required Type Default
remove Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the flag that tells the framework not to render, just execute
Description:  
OVERRIDEEVENT
function overrideEvent
Arguments:
Name Required Type Default
event Optional Any  
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Override the current event in the request collection. This method does not execute the event, it just replaces the event to be executed by the framework's RunEvent() method. This method is usually called from an onRequestStart or onApplicationStart method.
Description:  
PARAMVALUE
function paramValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: Just like cfparam, but for the request collection
Description:  
PERSISTVARIABLES
function persistVariables
Arguments:
Name Required Type Default
persist Optional string [empty string]
persistStruct Optional struct  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Persist variables for flash redirections
Description:  
POPULATEMODEL
function populateModel
Arguments:
Name Required Type Default
model Required any  
scope Optional any [empty string]
trustedSetter Optional boolean false
include Optional any [empty string]
exclude Optional any [empty string]
ignoreEmpty Optional boolean false
nullEmptyInclude Optional string [empty string]
nullEmptyExclude Optional string [empty string]
composeRelationships Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Populate a named or instantiated model (java/cfc) from the request collection items
Description:  
POPULATEPROPERTYMIXIN
function populatePropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
propertyValue Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Populates a property if it exists
Description:  
RELOCATE
function relocate
Arguments:
Name Required Type Default
url Required string  
addtoken Optional boolean false
postProcessExempt Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: This method will be deprecated, please use setNextEvent() instead.
Description:  
REMOVEEVENTCACHEABLEENTRY
function removeEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Remove the cacheable entry
Description:  
REMOVEMIXIN
function removeMixin
Arguments:
Name Required Type Default
UDFName Required string  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Removes a method in a CFC
Description:  
REMOVEPROPERTYMIXIN
function removePropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: removes a property from the cfc used.
Description:  
REMOVEVALUE
function removeValue
Arguments:
Name Required Type Default
name Required string  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I remove a value in the request collection
Description:  
RENDERDATA
function renderData
Arguments:
Name Required Type Default
type Optional string HTML
data Required any  
contentType Required string [empty string]
encoding Optional string utf-8
statusCode Optional numeric 200
statusText Optional string [empty string]
location Optional string [empty string]
jsonCallback Optional string [empty string]
jsonQueryFormat Optional string query
jsonAsText Optional boolean false
xmlColumnList Optional string [empty string]
xmlUseCDATA Optional boolean false
xmlListDelimiter Optional string ,
xmlRootName Optional string [empty string]
pdfArgs Optional struct [runtime expression]
formats Optional any [empty string]
formatsView Optional any [empty string]
isBinary Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Use this method to tell the framework to render data for you. The framework will take care of marshalling the data for you
Description:  
RENDEREXTERNALVIEW
function renderExternalView
Arguments:
Name Required Type Default
view Required any  
cache Optional any  
cacheTimeout Optional any  
cacheLastAccessTimeout Optional any  
cacheSuffix Optional any  
args Optional struct [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Renders external views
Description:  
RENDERLAYOUT
function renderLayout
Arguments:
Name Required Type Default
layout Optional any  
view Optional any  
module Optional any  
args Optional struct [runtime expression]
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: Renders a layout with view combinations
Description:  
RENDERVIEW
function renderView
Arguments:
Name Required Type Default
view Required any  
cache Optional any  
cacheTimeout Optional any  
cacheLastAccessTimeout Optional any  
cacheSuffix Optional any  
module Optional any  
args Optional struct [runtime expression]
collection Optional any  
collectionAs Optional any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Renders all kinds of views
Description:  
RENDERWITHFORMATS
function renderWithFormats
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Render With Formats
Description:  
RUNEVENT
function runEvent
Arguments:
Name Required Type Default
event Optional any [empty string]
prepostExempt Optional any false
private Optional any false
default Optional any false
eventArguments Optional any [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to controller's runEvent() method.
Description:  
SETDEBUGMODE
function setDebugMode
Arguments:
Name Required Type Default
mode Required boolean  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to set your debug mode
Description:  
SETDEFAULTLAYOUT
function setDefaultLayout
Arguments:
Name Required Type Default
DefaultLayout Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default layout for a request
Description:  
SETDEFAULTVIEW
function setDefaultView
Arguments:
Name Required Type Default
DefaultView Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default view for a request
Description:  
SETEVENTCACHEABLEENTRY
function setEventCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the event cacheable entry
Description:  
SETFWLOCALE
function setfwLocale
Arguments:
Name Required Type Default
locale Optional any  
dontloadRBFlag Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the default locale to use in the framework for a specific user. Utility Method
Description:  
SETHTTPHEADER
function setHTTPHeader
Arguments:
Name Required Type Default
statusCode Optional string  
statusText Optional string [empty string]
name Optional string  
value Optional string [empty string]
charset Optional string UTF-8
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set an HTTP Header
Description:  
SETISSES
function setisSES
Arguments:
Name Required Type Default
isSES Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the isSES flag, usualy done by the SES interceptor
Description:  
SETLAYOUT
function setLayout
Arguments:
Name Required Type Default
name Required Any  
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the layout to override and render. Layouts are pre-defined in the config file. However I can override these settings if needed. Do not append a the cfm extension. Private Request Collection name: currentLayout
Description:  
SETMEMENTO
function setMemento
Arguments:
Name Required Type Default
memento Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the state of this request context
Description:  
SETNEXTEVENT
function setNextEvent
Arguments:
Name Required Type Default
event Optional string  
queryString Optional string  
addToken Optional boolean  
persist Optional string  
persistStruct Optional struct  
ssl Optional boolean  
baseURL Optional string  
postProcessExempt Optional boolean  
URL Optional string  
URI Optional string  
statusCode Optional numeric  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
SETNEXTROUTE
function setNextRoute
Arguments:
Name Required Type Default
route Required string  
persist Optional string [empty string]
persistStruct Optional struct  
addToken Optional boolean false
ssl Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: This method is now deprecated, please use setNextEvent(). This method will be removed later on
Description:  
SETPROXYREQUEST
function setProxyRequest
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that this is a proxy request
Description:  
SETREQUESTCONTEXT
function setRequestContext
Arguments:
Name Required Type Default
requestContext Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: DO NOT OVERRIDE: Set the original request context.
Description:  
SETROUTEDSTRUCT
function setRoutedStruct
Arguments:
Name Required Type Default
routedStruct Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set routed struct of key-value pairs. This is used only by the SES interceptor. Not for public use.
Description:  
SETSESBASEURL
function setSESBaseURL
Arguments:
Name Required Type Default
sesBaseURL Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the ses base URL for this request
Description:  
SETSETTING
function setSetting
Arguments:
Name Required Type Default
name Required any  
value Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
SETTINGEXISTS
function settingExists
Arguments:
Name Required Type Default
name Required any  
FWSetting Optional boolean false
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
SETVALUE
function setValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Set a value in the request collection
Description:  
SETVIEW
function setView
Arguments:
Name Required Type Default
view Optional any  
nolayout Optional boolean false
cache Optional boolean false
cacheTimeout Optional any [empty string]
cacheLastAccessTimeout Optional any [empty string]
cacheSuffix Optional any [empty string]
cacheProvider Optional any template
layout Optional any  
module Optional any [empty string]
args Optional struct [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the view to render in this request. Private Request Collection Name: currentView, currentLayout
Description:  
SETVIEWCACHEABLEENTRY
function setViewCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the view cacheable entry
Description:  
SHOWDEBUGPANEL
function showDebugPanel
Arguments:
Name Required Type Default
show Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I can override to show or not the debug panel. Very useful in AJAX debugging
Description:  
VALIDATEMODEL
function validateModel
Arguments:
Name Required Type Default
target Required any  
fields Optional string *
constraints Optional any  
locale Optional string [empty string]
excludeFields Optional string [empty string]
ReturnType: coldbox.system.validation.result.IValidationResult
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Validate a target object
Description:  
VALUEEXISTS
function valueExists
Arguments:
Name Required Type Default
name Required any  
private Optional boolean false
ReturnType: boolean
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Check if a value exists in the request collection.
Description:  
POSTHANDLER_EXCEPT [empty string]
PREHANDLER_EXCEPT [empty string]
AROUNDHANDLER_ONLY [empty string]
ALLOWEDMETHODS
struct [empty]
AROUNDHANDLER_EXCEPT [empty string]
$MIXED true
POSTHANDLER_ONLY [empty string]
METHODS
$ABORT
function $abort
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade for cfabort
Description:  
$DUMP
function $dump
Arguments:
Name Required Type Default
var Required any  
isAbort Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Facade for cfmx dump
Description:  
$HTMLHEAD
function $htmlhead
Arguments:
Name Required Type Default
content Required string  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to cfhtmlhead
Description:  
$INCLUDE
function $include
Arguments:
Name Required Type Default
template Optional string  
ReturnType: void
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Facade for cfinclude
Description:  
$RETHROW
function $rethrow
Arguments:
Name Required Type Default
throwObject Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Rethrow facade
Description:  
$THROW
function $throw
Arguments:
Name Required Type Default
message Required string  
detail Optional string [empty string]
type Optional string Framework
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade for cfthrow
Description:  
_ACTIONEXISTS
function _actionExists
Arguments:
Name Required Type Default
action Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Checks if an action is defined, either public or private
Description:  
_PRIVATEINVOKER
function _privateInvoker
Arguments:
Name Required Type Default
method Required Any  
argCollection Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: calls private/packaged/public methods. Used internally by coldbox to execute private events
Description:  
ADDASSET
function addAsset
Arguments:
Name Required Type Default
asset Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Add a js/css asset(s) to the html head section. You can also pass in a list of assets.
Description:  
ADDGAMESCORE
function addGameScore
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDSCORES
function addScores
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ANNOUNCEINTERCEPTION
function announceInterception
Arguments:
Name Required Type Default
state Required any  
interceptData Optional any  
async Optional boolean false
asyncAll Optional boolean false
asyncAllJoin Optional boolean true
asyncPriority Optional string NORMAL
asyncJoinTimeout Optional numeric 0
ReturnType: any
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Announce an interception to the system. If you use the asynchronous facilities, you will get a thread structure report as a result.
Description:  
BEANTEST
function beanTest
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
BUILDLINK
function buildLink
Arguments:
Name Required Type Default
linkto Required string  
translate Optional boolean true
ssl Optional boolean false
baseURL Optional string [empty string]
queryString Optional string [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Builds a link to a passed event, either SES or normal link. If the ses interceptor is declared it will create routes.
Description:  
CLEARCOLLECTION
function clearCollection
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Clears the entire collection
Description:  
COLLECTIONAPPEND
function collectionAppend
Arguments:
Name Required Type Default
collection Required any  
overwrite Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Append a structure to the collection, with overwrite or not. Overwrite = false by default
Description:  
CONFIGURE
function configure
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override to provide a pseudo-constructor for your decorator
Description:  
EXPOSEMIXIN
function exposeMixin
Arguments:
Name Required Type Default
method Required Any  
newName Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Exposes a private function publicly
Description:  
GETCOLDBOXOCM
function getColdboxOCM
Arguments:
Name Required Type Default
cacheName Optional any default
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a CacheBox Cache of type: coldbox.system.cache.IColdboxApplicationCache
Description:  
GETCOLLECTION
function getCollection
Arguments:
Name Required Type Default
deepCopyFlag Optional boolean false
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a reference or deep copy of the public or private request Collection
Description:  
GETCONTROLLER
function getController
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get controller: coldbox.system.web.Controller
Description:  
GETCURRENTACTION
function getCurrentAction
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current action requested in the current event: String
Description:  
GETCURRENTEVENT
function getCurrentEvent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current incoming event
Description:  
GETCURRENTHANDLER
function getCurrentHandler
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current handler requested in the current event: String
Description:  
GETCURRENTLAYOUT
function getCurrentLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout for rendering
Description:  
GETCURRENTLAYOUTMODULE
function getCurrentLayoutModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set layout's module for rendering
Description:  
GETCURRENTMODULE
function getCurrentModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current module name, else returns empty string
Description:  
GETCURRENTROUTE
function getCurrentRoute
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current request's SES route that matched
Description:  
GETCURRENTROUTEDNAMESPACE
function getCurrentRoutedNamespace
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed namespace that matched the SES route, if any
Description:  
GETCURRENTROUTEDURL
function getCurrentRoutedURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the current routed URL that matched the SES route
Description:  
GETCURRENTVIEW
function getCurrentView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWARGS
function getCurrentViewArgs
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
Description:  
GETCURRENTVIEWMODULE
function getCurrentViewModule
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set views's module for rendering
Description:  
GETDATASOURCE
function getDatasource
Arguments:
Name Required Type Default
alias Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I will return to you a datasourceBean according to the alias of the datasource you wish to get from the configstruct
Description:  
GETDEBUGMODE
function getDebugMode
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to get your current debug mode
Description:  
GETDEBUGPANELFLAG
function getDebugPanelFlag
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I return the debugpanel flag for this request.
Description:  
GETDEFAULTLAYOUT
function getDefaultLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default layout of the application: String
Description:  
GETDEFAULTVIEW
function getDefaultView
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get's the default view of the application: String
Description:  
GETEVENTCACHEABLEENTRY
function getEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETEVENTNAME
function getEventName
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: The event name used by the application: String
Description:  
GETFOLDERLAYOUTS
function getFolderLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered folder layout associations map
Description:  
GETFWLOCALE
function getfwLocale
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the user's currently set locale or default locale
Description:  
GETHTTPBASICCREDENTIALS
function getHTTPBasicCredentials
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the username and password sent via HTTP basic authentication
Description:  
GETHTTPCONTENT
function getHTTPContent
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the raw HTTP content
Description:  
GETHTTPHEADER
function getHTTPHeader
Arguments:
Name Required Type Default
header Required string  
default Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a HTTP header
Description:  
GETHTTPMETHOD
function getHTTPMethod
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the HTTP Request Method Type
Description:  
GETINTERCEPTOR
function getInterceptor
Arguments:
Name Required Type Default
interceptorName Optional any  
deepSearch Optional any false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get an interceptor
Description:  
GETMAILSERVICE
function getMailService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a reference to our Mail Service plugin
Description:  
GETMAILSETTINGS
function getMailSettings
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I will return to you a mailsettingsBean modeled after your mail settings in your config file.
Description:  
GETMEMENTO
function getMemento
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the memento of this object
Description:  
GETMODEL
function getModel
Arguments:
Name Required Type Default
name Optional Any  
dsl Optional Any  
initArguments Optional Any [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Create or retrieve model objects by convention
Description:  
GETMODULEROOT
function getModuleRoot
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Convenience method to get the current request's module root path. If no module, then returns empty path. You can also get this from the modules settings.
Description:  
GETMODULESETTINGS
function getModuleSettings
Arguments:
Name Required Type Default
module Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a module's setting structure if it exists
Description:  
GETMYPLUGIN
function getMyPlugin
Arguments:
Name Required Type Default
plugin Required any  
newInstance Optional any false
module Optional any [empty string]
init Optional any true
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETNEWMAIL
function getNewMail
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get a new mail payload object ready for sending email through our mail service. This function's arguments match the cfmail tag, so send whatever you like
Description:  
GETPLUGIN
function getPlugin
Arguments:
Name Required Type Default
plugin Optional any  
customPlugin Optional any false
newInstance Optional any false
module Optional any [empty string]
init Optional any true
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETPROPERTYMIXIN
function getPropertyMixin
Arguments:
Name Required Type Default
name Required Any  
scope Optional Any variables
default Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: gets a property
Description:  
GETREGISTEREDLAYOUTS
function getRegisteredLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get all the registered layouts in the configuration file
Description:  
GETRENDERDATA
function getRenderData
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the renderData structure.
Description:  
GETREQUESTCONTEXT
function getRequestContext
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the original request context. coldbox.system.web.context.RequestContext
Description:  
GETRESOURCE
function getResource
Arguments:
Name Required Type Default
resource Required any  
default Optional any  
locale Optional any  
values Optional any  
bundle Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to i18n.getResource. Returns a string.
Description:  
GETROUTEDSTRUCT
function getRoutedStruct
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the routed structure of key-value pairs. What the ses interceptor could match.
Description:  
GETSELF
function getSelf
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns index.cfm?{eventName}= : String
Description:  
GETSESBASEURL
function getSESBaseURL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the ses base URL for this request
Description:  
GETSETTING
function getSetting
Arguments:
Name Required Type Default
name Required any  
FWSetting Optional boolean false
defaultValue Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETSETTINGSBEAN
function getSettingsBean
Arguments:
Name Required Type Default
FWSetting Optional boolean false
ReturnType: coldbox.system.core.collections.ConfigBean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns a configBean with all the configuration structure.
Description:  
GETSETTINGSTRUCTURE
function getSettingStructure
Arguments:
Name Required Type Default
FWSetting Optional boolean false
DeepCopyFlag Optional boolean false
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
GETSIZE
function getSize
Arguments:
Name Required Type Default
private Optional boolean false
ReturnType: numeric
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns the number of elements in the collection
Description:  
GETTRIMVALUE
function getTrimValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional boolean false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the request collection and if simple value, I will trim it.
Description:  
GETVALIDATIONMANAGER
function getValidationManager
Arguments:none
ReturnType: coldbox.system.validation.IValidationManager
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Retrieve the application's configured Validation Manager
Description:  
GETVALUE
function getValue
Arguments:
Name Required Type Default
name Required any  
defaultValue Optional any  
private Optional any false
ReturnType: Any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Get a value from the public or private request collection.
Description:  
GETVIEWCACHEABLEENTRY
function getViewCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the event cacheable entry
Description:  
GETVIEWLAYOUTS
function getViewLayouts
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the registered view layout associations map
Description:  
INCLUDEITMIXIN
function includeitMixin
Arguments:
Name Required Type Default
template Required Any  
ReturnType: void
Roles:  
Access: public
Output: true
DisplayName:  
Hint: Facade for cfinclude
Description:  
INCLUDEUDF
function includeUDF
Arguments:
Name Required Type Default
udflibrary Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Injects a UDF Library (*.cfc or *.cfm) into the target object. It does not however, put the mixins on any of the cfc scopes. Therefore they can only be called internally.
Description:  
INDEX
function index
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INDEX2
function index2
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
oContext Required any  
controller Required any  
ReturnType: RequestContextDecorator
Roles:  
Access: public
Output: false
DisplayName:  
Hint: constructor
Description:  
INJECTMIXIN
function injectMixin
Arguments:
Name Required Type Default
name Required Any  
UDF Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Injects a method into the CFC
Description:  
INJECTPROPERTYMIXIN
function injectPropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
propertyValue Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: injects a property into the passed scope
Description:  
INVOKERMIXIN
function invokerMixin
Arguments:
Name Required Type Default
method Required Any  
argCollection Optional Any  
argList Optional Any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Calls private/packaged/public methods
Description:  
ISAJAX
function isAjax
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determines if in an Ajax call or not by looking at the request headers
Description:  
ISEVENTCACHEABLE
function isEventCacheable
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming event has been flagged for caching. Boolean
Description:  
ISNOEXECUTION
function isNoExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if we need to execute an incoming event or not.
Description:  
ISNORENDER
function isNoRender
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a no render request
Description:  
ISPROXYREQUEST
function isProxyRequest
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Is this a coldbox proxy request
Description:  
ISSES
function isSES
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Determine if you are in SES mode.
Description:  
ISSSL
function isSSL
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Returns boolean result whether current request is in ssl or not
Description:  
ISVIEWCACHEABLE
function isViewCacheable
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Check wether the incoming view has been flagged for caching
Description:  
LOADGLOBALUDFLIBRARIES
function loadGlobalUDFLibraries
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Load the global UDF libraries defined in the UDFLibraryFile Setting
Description:  
LOCATEDIRECTORYPATH
function locateDirectoryPath
Arguments:
Name Required Type Default
pathToCheck Required any  
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Locate the real path location of a directory in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path
Description:  
LOCATEFILEPATH
function locateFilePath
Arguments:
Name Required Type Default
pathToCheck Required any  
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Locate the real path location of a file in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path
Description:  
MAIN
function main
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
METHODPROXY
function methodProxy
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: a method proxy
Description:  
NOEXECUTION
function noExecution
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that the request will not execute an incoming event. Most likely simulating a servlet call.
Description:  
NOLAYOUT
function noLayout
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Mark this request to not use a layout for rendering
Description:  
NORENDER
function noRender
Arguments:
Name Required Type Default
remove Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the flag that tells the framework not to render, just execute
Description:  
OVERRIDEEVENT
function overrideEvent
Arguments:
Name Required Type Default
event Optional Any  
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Override the current event in the request collection. This method does not execute the event, it just replaces the event to be executed by the framework's RunEvent() method. This method is usually called from an onRequestStart or onApplicationStart method.
Description:  
PARAMVALUE
function paramValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: Just like cfparam, but for the request collection
Description:  
PERSISTVARIABLES
function persistVariables
Arguments:
Name Required Type Default
persist Optional string [empty string]
persistStruct Optional struct  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Persist variables for flash redirections
Description:  
POPULATEMODEL
function populateModel
Arguments:
Name Required Type Default
model Required any  
scope Optional any [empty string]
trustedSetter Optional boolean false
include Optional any [empty string]
exclude Optional any [empty string]
ignoreEmpty Optional boolean false
nullEmptyInclude Optional string [empty string]
nullEmptyExclude Optional string [empty string]
composeRelationships Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Populate a named or instantiated model (java/cfc) from the request collection items
Description:  
POPULATEPROPERTYMIXIN
function populatePropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
propertyValue Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Populates a property if it exists
Description:  
RELOCATE
function relocate
Arguments:
Name Required Type Default
url Required string  
addtoken Optional boolean false
postProcessExempt Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: This method will be deprecated, please use setNextEvent() instead.
Description:  
REMOVEEVENTCACHEABLEENTRY
function removeEventCacheableEntry
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Remove the cacheable entry
Description:  
REMOVEMIXIN
function removeMixin
Arguments:
Name Required Type Default
UDFName Required string  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Removes a method in a CFC
Description:  
REMOVEPROPERTYMIXIN
function removePropertyMixin
Arguments:
Name Required Type Default
propertyName Required Any  
scope Optional Any variables
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: removes a property from the cfc used.
Description:  
REMOVEVALUE
function removeValue
Arguments:
Name Required Type Default
name Required string  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I remove a value in the request collection
Description:  
RENDERDATA
function renderData
Arguments:
Name Required Type Default
type Optional string HTML
data Required any  
contentType Required string [empty string]
encoding Optional string utf-8
statusCode Optional numeric 200
statusText Optional string [empty string]
location Optional string [empty string]
jsonCallback Optional string [empty string]
jsonQueryFormat Optional string query
jsonAsText Optional boolean false
xmlColumnList Optional string [empty string]
xmlUseCDATA Optional boolean false
xmlListDelimiter Optional string ,
xmlRootName Optional string [empty string]
pdfArgs Optional struct [runtime expression]
formats Optional any [empty string]
formatsView Optional any [empty string]
isBinary Optional boolean false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Use this method to tell the framework to render data for you. The framework will take care of marshalling the data for you
Description:  
RENDEREXTERNALVIEW
function renderExternalView
Arguments:
Name Required Type Default
view Required any  
cache Optional any  
cacheTimeout Optional any  
cacheLastAccessTimeout Optional any  
cacheSuffix Optional any  
args Optional struct [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Renders external views
Description:  
RENDERLAYOUT
function renderLayout
Arguments:
Name Required Type Default
layout Optional any  
view Optional any  
module Optional any  
args Optional struct [runtime expression]
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: Renders a layout with view combinations
Description:  
RENDERVIEW
function renderView
Arguments:
Name Required Type Default
view Required any  
cache Optional any  
cacheTimeout Optional any  
cacheLastAccessTimeout Optional any  
cacheSuffix Optional any  
module Optional any  
args Optional struct [runtime expression]
collection Optional any  
collectionAs Optional any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Renders all kinds of views
Description:  
RENDERWITHFORMATS
function renderWithFormats
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Render With Formats
Description:  
RUNEVENT
function runEvent
Arguments:
Name Required Type Default
event Optional any [empty string]
prepostExempt Optional any false
private Optional any false
default Optional any false
eventArguments Optional any [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to controller's runEvent() method.
Description:  
SETDEBUGMODE
function setDebugMode
Arguments:
Name Required Type Default
mode Required boolean  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade to set your debug mode
Description:  
SETDEFAULTLAYOUT
function setDefaultLayout
Arguments:
Name Required Type Default
DefaultLayout Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default layout for a request
Description:  
SETDEFAULTVIEW
function setDefaultView
Arguments:
Name Required Type Default
DefaultView Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Override the default view for a request
Description:  
SETEVENTCACHEABLEENTRY
function setEventCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the event cacheable entry
Description:  
SETFWLOCALE
function setfwLocale
Arguments:
Name Required Type Default
locale Optional any  
dontloadRBFlag Optional any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the default locale to use in the framework for a specific user. Utility Method
Description:  
SETHTTPHEADER
function setHTTPHeader
Arguments:
Name Required Type Default
statusCode Optional string  
statusText Optional string [empty string]
name Optional string  
value Optional string [empty string]
charset Optional string UTF-8
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set an HTTP Header
Description:  
SETISSES
function setisSES
Arguments:
Name Required Type Default
isSES Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the isSES flag, usualy done by the SES interceptor
Description:  
SETLAYOUT
function setLayout
Arguments:
Name Required Type Default
name Required Any  
module Optional Any [empty string]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the layout to override and render. Layouts are pre-defined in the config file. However I can override these settings if needed. Do not append a the cfm extension. Private Request Collection name: currentLayout
Description:  
SETMEMENTO
function setMemento
Arguments:
Name Required Type Default
memento Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the state of this request context
Description:  
SETNEXTEVENT
function setNextEvent
Arguments:
Name Required Type Default
event Optional string  
queryString Optional string  
addToken Optional boolean  
persist Optional string  
persistStruct Optional struct  
ssl Optional boolean  
baseURL Optional string  
postProcessExempt Optional boolean  
URL Optional string  
URI Optional string  
statusCode Optional numeric  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
SETNEXTROUTE
function setNextRoute
Arguments:
Name Required Type Default
route Required string  
persist Optional string [empty string]
persistStruct Optional struct  
addToken Optional boolean false
ssl Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: This method is now deprecated, please use setNextEvent(). This method will be removed later on
Description:  
SETPROXYREQUEST
function setProxyRequest
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set that this is a proxy request
Description:  
SETREQUESTCONTEXT
function setRequestContext
Arguments:
Name Required Type Default
requestContext Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: DO NOT OVERRIDE: Set the original request context.
Description:  
SETROUTEDSTRUCT
function setRoutedStruct
Arguments:
Name Required Type Default
routedStruct Required struct  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set routed struct of key-value pairs. This is used only by the SES interceptor. Not for public use.
Description:  
SETSESBASEURL
function setSESBaseURL
Arguments:
Name Required Type Default
sesBaseURL Required string  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the ses base URL for this request
Description:  
SETSETTING
function setSetting
Arguments:
Name Required Type Default
name Required any  
value Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
SETTINGEXISTS
function settingExists
Arguments:
Name Required Type Default
name Required any  
FWSetting Optional boolean false
ReturnType: boolean
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Facade
Description:  
SETVALUE
function setValue
Arguments:
Name Required Type Default
name Required any  
value Required any  
private Optional boolean false
ReturnType: any
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Set a value in the request collection
Description:  
SETVIEW
function setView
Arguments:
Name Required Type Default
view Optional any  
nolayout Optional boolean false
cache Optional boolean false
cacheTimeout Optional any [empty string]
cacheLastAccessTimeout Optional any [empty string]
cacheSuffix Optional any [empty string]
cacheProvider Optional any template
layout Optional any  
module Optional any [empty string]
args Optional struct [runtime expression]
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the view to render in this request. Private Request Collection Name: currentView, currentLayout
Description:  
SETVIEWCACHEABLEENTRY
function setViewCacheableEntry
Arguments:
Name Required Type Default
mdCacheEntry Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the view cacheable entry
Description:  
SHOWDEBUGPANEL
function showDebugPanel
Arguments:
Name Required Type Default
show Required boolean  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I can override to show or not the debug panel. Very useful in AJAX debugging
Description:  
TEST
function test
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
TEST2
function test2
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
TEST3
function test3
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
VALIDATEMODEL
function validateModel
Arguments:
Name Required Type Default
target Required any  
fields Optional string *
constraints Optional any  
locale Optional string [empty string]
excludeFields Optional string [empty string]
ReturnType: coldbox.system.validation.result.IValidationResult
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Validate a target object
Description:  
VALUEEXISTS
function valueExists
Arguments:
Name Required Type Default
name Required any  
private Optional boolean false
ReturnType: boolean
Roles:  
Access: Public
Output: false
DisplayName:  
Hint: I Check if a value exists in the request collection.
Description:  
WINDOWTEST1
function windowTest1
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
WINDOWTEST2
function windowTest2
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
WINDOWTEST3
function windowTest3
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
WINDOWTEST4
function windowTest4
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
WINDOWTEST5
function windowTest5
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
WINDOWTEST6
function windowTest6
Arguments:
Name Required Type Default
event Optional Any  
rc Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description: