Variables - struct
ATTRIBUTES_SKIPCUSTOMERCODE 0
FST 2019-12-14 19:38:37.279
SAVED_TIMINGS
Variables - component commonspot.components.util.debug-timing
        extends commonspot.components.base-component
LIMIT_TO_SCALABILITY_MAX -1
METHODS
ADDEVENT
Variables - function addEvent
Arguments:
Name Required Type Default
comment Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: add a new event to the collection
Description:  
BOOLTOINT
Variables - function boolToInt
Arguments:
Name Required Type Default
bool Required boolean  
ReturnType: numeric
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
CALLMETHOD
Variables - function callMethod
Arguments:
Name Required Type Default
methodName Required string  
Args Optional any [empty string]
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: wrapper method to make sure remote calls are correctly scoped
Description:  
CFABORT
Variables - function cfAbort
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
DBG
Variables - function dbg
Arguments:
Name Required Type Default
value Optional any _THIS_ARGUMENT_WAS_NOT_PASSED_
scope Optional struct [runtime expression]
showLocation Optional boolean no
showAsHTML Optional boolean no
clear Optional boolean no
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Dev debug function, appends passed args to array aDbg in requested scope for readout purposes. If one argument named 'value' is passed, only, then its value alone will be appended. Otherwise, all named args besides config ones listed below are appended as a struct. Something needs to show it; dashboard cmd toolkit does automatically, other situations needs to roll their own, by calling someObject.dbgReadout(). To see queries from within a dashboard cmd, set showAsHTML true, and they'll show below the main result display. Non-html dbg calls get inserted into cmd result status, so display goes through serialization and back, and that doesn't support queries.
Description:  
DBGOUT
Variables - function dbgOut
Arguments:none
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: debug utility, outputs passed value or arguments struct, regardless of method output settings
Description:  
DBGREADOUT
Variables - function dbgReadout
Arguments:
Name Required Type Default
scope Optional struct [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: yes
DisplayName:  
Hint: Dev debug readout; see dbg().
Description:  
FORMATTIME
Variables - function formatTime
Arguments:
Name Required Type Default
ticks Required numeric  
ReturnType: string
Roles:  
Access: private
Output:  
DisplayName:  
Hint: formats the time portion of a given tick count with the milliseconds portion padded out to 3 places
Description:  
FORMATTS
Variables - function formatTS
Arguments:
Name Required Type Default
ticks Required numeric  
width Optional numeric 8
ReturnType: string
Roles:  
Access: private
Output:  
DisplayName:  
Hint: formats a given tick count, returning a string padded to the requested number of characters
Description:  
GETCALLINGTEMPLATELOCATION
Variables - function getCallingTemplateLocation
Arguments:none
ReturnType: struct
Roles:  
Access: private
Output: 1
DisplayName:  
Hint: Returns the name and line number of the code that called the code that called this. For debug readouts.
Description:  
GETDSN
Variables - function getDSN
Arguments:
Name Required Type Default
dsnType Required string  
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Returns name of requested CommonSpot DSN.
Description:  
GETDUMP
Variables - function getDump
Arguments:
Name Required Type Default
var Optional any [empty string]
label Optional Any [empty string]
expand Optional Any 1
ReturnType: string
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Dev tool; returns cfdump of requested var. Can pass either arguments.var (or un-named first argument) or arguments.varPath. varPath is resolved using StructGet, and can refer to private internal data.
Description:  
GETELAPSEDTICKS
Variables - function getElapsedTicks
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint: returns the elapsed time since this object was initialized
Description:  
GETERRORMSG
Variables - function getErrorMsg
Arguments:
Name Required Type Default
reasonCode Required string  
msgParam1 Optional string [runtime expression]
msgParam2 Optional string [runtime expression]
msgParam3 Optional string [runtime expression]
msgParam4 Optional string [runtime expression]
msgParam5 Optional string [runtime expression]
msgParam6 Optional string [runtime expression]
msgParam7 Optional string [runtime expression]
msgParam8 Optional string [runtime expression]
msgParam9 Optional string [runtime expression]
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Looks up the error message corresponding to a passed error code
Description:  
GETHASHCODE
Variables - function getHashCode
Arguments:
Name Required Type Default
obj Optional any [runtime expression]
ReturnType: numeric
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Returns hash identifier of an object, defaulting to 'this'. NEEDSWORK: This recreates java system object every time; that lets it be used before object factory is set up, but if we use this a lot, do something else.
Description:  
GETMODULEVALIDURL
Variables - function getModuleValidURL
Arguments:
Name Required Type Default
module Required string  
type Required string  
ReturnType: string
Roles:  
Access: private
Output:  
DisplayName:  
Hint:
Description:  
GETRESULTSHTML
Variables - function getResultsHTML
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: report on timing array contents, formatted in an HTML table for browser display
Description:  
GETRESULTSTEXT
Variables - function getResultsText
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: report on timing array contents, formatted as plain text for logging
Description:  
GETTEMPLATEINHERITANCELIST
Variables - function getTemplateInheritanceList
Arguments:
Name Required Type Default
pageID Required any  
ReturnType: string
Roles:  
Access: private
Output: no
DisplayName:  
Hint: Returns the InheritedTemplateList for the passed pageID. For flexibility, DOES NOT include the passed pageID itself.
Description:  
GETVAR
Variables - function getVar
Arguments:
Name Required Type Default
path Required string  
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Dev tool; returns any complex value, given path to it.
Description:  
GETVARIABLESDATA
Variables - function getVariablesData
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Returns a struct w a list of all vars in the variables space, and for any of those that are components that have this method defined, a struct with the names of NEEDSWORK.
Description:  
INIT
Variables - function init
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PICK
Variables - function pick
Arguments:
Name Required Type Default
bool Required boolean  
choice1 Required any  
choice2 Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:
Description:  
QUERYROWTOSTRUCT
Variables - function queryRowToStruct
Arguments:
Name Required Type Default
query Required query  
rowNum Optional numeric 1
colsList Optional string [runtime expression]
LCaseNames Optional boolean yes
targetStruct Optional struct [runtime expression]
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: Returns a struct w requested data from a requested query row.
Description:  
QUERYROWTOTYPEDSTRUCT
Variables - function queryRowToTypedStruct
Arguments:
Name Required Type Default
query Required query  
targetType Optional string [empty string]
lockKeySet Optional boolean yes
rowNum Optional numeric 1
colsList Optional string [runtime expression]
LCaseNames Optional boolean yes
ReturnType: struct
Roles:  
Access: private
Output: no
DisplayName:  
Hint: Returns a commonspot type struct w requested data from a requested query row.
Description:  
RETHROWWITHINTERNALERRORCODE
Variables - function reThrowWithInternalErrorCode
Arguments:
Name Required Type Default
reasonCode Required string  
cause Required any  
msgParam1 Optional string [runtime expression]
msgParam2 Optional string [runtime expression]
msgParam3 Optional string [runtime expression]
msgParam4 Optional string [runtime expression]
msgParam5 Optional string [runtime expression]
msgParam6 Optional string [runtime expression]
msgParam7 Optional string [runtime expression]
msgParam8 Optional string [runtime expression]
msgParam9 Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Rethrows a caught exception wrapped with a given an error code.
Description:  
STRUCTTOTEXT
Variables - function structToText
Arguments:
Name Required Type Default
struct Required any  
isCFCatch Optional boolean false
ReturnType: string
Roles:  
Access: private
Output: false
DisplayName:  
Hint:
Description:  
THROWARGUMENTREFUSALCODE
Variables - function throwArgumentRefusalCode
Arguments:
Name Required Type Default
reasonCode Required string  
methodName Required string  
argumentName Required string  
msgParam1 Optional string [runtime expression]
msgParam2 Optional string [runtime expression]
msgParam3 Optional string [runtime expression]
msgParam4 Optional string [runtime expression]
msgParam5 Optional string [runtime expression]
msgParam6 Optional string [runtime expression]
msgParam7 Optional string [runtime expression]
msgParam8 Optional string [runtime expression]
msgParam9 Optional string [runtime expression]
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Throws a command refusal error exception given an error code.
Description:  
THROWCMDREFUSAL
Variables - function throwCmdRefusal
Arguments:
Name Required Type Default
msg Required string  
reasonCode Optional string [empty string]
errorCode Optional numeric [runtime expression]
ReturnType: void
Roles:  
Access: private
Output: no
DisplayName:  
Hint: NEEDSWORK
Description:  
THROWCMDREFUSALCODE
Variables - function throwCmdRefusalCode
Arguments:
Name Required Type Default
reasonCode Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Throws a command refusal error exception given an error code.
Description:  
THROWINTERNALERRORCODE
Variables - function throwInternalErrorCode
Arguments:
Name Required Type Default
reasonCode Required string  
ReturnType: void
Roles:  
Access: public
Output: no
DisplayName:  
Hint: Throws an internal error exception given an error code.
Description:  
WRITEDUMPFILE
Variables - function writeDumpFile
Arguments:
Name Required Type Default
var Required any  
file Required string  
label Optional string [empty string]
append Optional boolean false
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Writes cfdump of requested var to requested file.
Description:  
TSOBJECT 2019-12-14 19:38:37.279
Looked Up Redirect Info - struct
CommonSpotPageID 0
RedirectURL [empty string]
StatusCode 404

/preview/handler404.cfm

/cust/webroot/site8/handler404.cfm /cust/webroot/site8/ YES

/preview/news/${article.url}

/cust/webroot/site8/news/${article.url} /cust/webroot/site8/${article.url} NO