My custom error page

includes/templates/error.cfm

If you are seeing this...
1. See what the standard error message looks like
2. check to see if you can output the Exception Bean on this page.

An Unhandled Exception Occurred

An unhandled exception has occurred. Please look at the diagnostic information below:
Type Expression
Message Element MENUID is undefined in MENUS.
Detail
Extended Info
Tag Context C:\websites\NorthHill-com\www\handlers\Menu.cfc (45)
C:\websites\NorthHill-com\www\coldbox\system\web\Controller.cfc (699)
C:\websites\NorthHill-com\www\coldbox\system\web\Controller.cfc (584)
C:\websites\NorthHill-com\www\coldbox\system\Coldbox.cfc (243)
C:\websites\NorthHill-com\www\Application.cfc (78)
Momento:
struct
CONTEXT
struct
MENUID [empty string]
event menu.page
exceptionBean
component coldbox.system.web.context.ExceptionBean
METHODS
$TOSTRING
function $toString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETDETAIL
function getDetail
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETERRNUMBER
function getErrNumber
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETERRORCODE
function getErrorCode
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETERRORTYPE
function getErrorType
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETEXCEPTIONSTRUCT
function getExceptionStruct
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETEXTENDEDINFO
function getExtendedInfo
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETEXTRAINFO
function getExtraInfo
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETEXTRAMESSAGE
function getExtraMessage
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETLOCKNAME
function getLockName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETLOCKOPERATION
function getLockOperation
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETMEMENTO
function getMemento
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the memento
Description:  
GETMESSAGE
function getMessage
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETMISSINGFILENAME
function getMissingFileName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETNATIVEERRORCODE
function getNativeErrorCode
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETQUERYERROR
function getQueryError
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETSQL
function getSql
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETSQLSTATE
function getSqlState
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETSTACKTRACE
function getStackTrace
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETTAGCONTEXT
function getTagContext
Arguments:none
ReturnType: array
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETTAGCONTEXTASSTRING
function getTagContextAsString
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I return the tagcontext in string format.
Description:  
GETTYPE
function getType
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETWHERE
function getWhere
Arguments:none
ReturnType: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
errorStruct Optional any [runtime expression]
extramessage Optional string [empty string]
extraInfo Optional any [empty string]
errorType Optional string application
ReturnType: ExceptionBean
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SETMEMENTO
function setMemento
Arguments:
Name Required Type Default
memento Required struct  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the memento
Description:  
stub photo-gallery
CONTROLLER
component coldbox.system.web.Controller
METHODS
GETAPPHASH
function getAppHash
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get AppHash
Description:  
GETAPPROOTPATH
function getAppRootPath
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get this application's physical path
Description:  
GETASPECTSINITIATED
function getAspectsInitiated
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get AspectsInitiated
Description:  
GETCACHEBOX
function getCacheBox
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the application's CacheBox instance as coldbox.system.cache.CacheFactory
Description:  
GETCFMLENGINE
function getCFMLEngine
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the CFMLEngine utility(coldbox.system.core.cf.CFMLEngine)
Description:  
GETCOLDBOXINITIATED
function getColdboxInitiated
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get ColdboxInitiated: Boolean
Description:  
GETCOLDBOXOCM
function getColdboxOCM
Arguments:
Name Required Type Default
cacheName Optional any default
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get ColdboxOCM: coldbox.system.cache.CacheManager or new CacheBox providers coldbox.system.cache.IColdboxApplicationCache
Description:  
GETCOLDBOXSETTINGS
function getColdboxSettings
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I retrieve the ColdBox Settings Structure by Reference
Description:  
GETCONFIGSETTINGS
function getConfigSettings
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I retrieve the Config Settings Structure by Reference
Description:  
GETDEBUGGERSERVICE
function getDebuggerService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get DebuggerService: coldbox.system.web.services.DebuggerService
Description:  
GETEXCEPTIONSERVICE
function getExceptionService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get ExceptionService: coldbox.system.web.services.ExceptionService
Description:  
GETHANDLERSERVICE
function getHandlerService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get HandlerService: coldbox.system.web.services.HandlerService
Description:  
GETINTERCEPTORSERVICE
function getInterceptorService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get interceptorService: coldbox.system.web.services.InterceptorService
Description:  
GETLOADERSERVICE
function getLoaderService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get LoaderService: coldbox.system.web.services.LoaderService
Description:  
GETLOGBOX
function getLogBox
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the application's LogBox instance
Description:  
GETMODULESERVICE
function getModuleService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get ModuleService: coldbox.system.web.services.ModuleService
Description:  
GETPLUGIN
function getPlugin
Arguments:
Name Required Type Default
plugin Required 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: I am the Plugin cfc object factory.
Description:  
GETPLUGINSERVICE
function getPluginService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get PluginService: coldbox.system.web.services.PluginService
Description:  
GETREQUESTSERVICE
function getRequestService
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get RequestService: coldbox.system.web.services.RequestService
Description:  
GETSERVICES
function getServices
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get all the registered services structure
Description:  
GETSETTING
function getSetting
Arguments:
Name Required Type Default
name Optional any  
FWSetting Optional any false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I get a setting from the FW Config structures. Use the FWSetting boolean argument to retrieve from the fwSettingsStruct.
Description:  
GETSETTINGSTRUCTURE
function getSettingStructure
Arguments:
Name Required Type Default
FWSetting Optional any false
deepCopyFlag Optional any false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Compatability & Utility Method. By default I retrieve the Config Settings. You can change this by using the FWSetting flag.
Description:  
GETUTIL
function getUtil
Arguments:none
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Create and return a util object
Description:  
GETWIREBOX
function getWireBox
Arguments:none
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Get the application's LogBox instance
Description:  
INIT
function init
Arguments:
Name Required Type Default
appRootPath Required any  
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Constructor
Description:  
INVOKER
function invoker
Arguments:
Name Required Type Default
target Required any  
method Required any  
argCollection Optional any [runtime expression]
private Optional any false
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Method Invoker
Description:  
PERSISTVARIABLES
function persistVariables
Arguments:
Name Required Type Default
persist Optional Any [empty string]
persistStruct Optional Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: @deprecated DO NOT USE ANYMORE. Persist variables for flash redirections, it can use a structure of name-value pairs or keys from the request collection. Use the flash object instead, this method will auto-save all persistence automatically.
Description:  
PUSHTIMERS
function pushTimers
Arguments:none
ReturnType: void
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Push timers into stack
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: I am an event handler runnable factory. If no event is passed in then it will run the default event from the config file.
Description:  
SENDRELOCATION
function sendRelocation
Arguments:
Name Required Type Default
url Required Any  
addtoken Optional Any false
statusCode Optional Any 0
ReturnType: void
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Send a CF relocation via ColdBox
Description:  
SETAPPHASH
function setAppHash
Arguments:
Name Required Type Default
appHash Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set AppHash
Description:  
SETAPPROOTPATH
function setAppRootPath
Arguments:
Name Required Type Default
appRootPath Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set this application's physical path.
Description:  
SETASPECTSINITIATED
function setAspectsInitiated
Arguments:
Name Required Type Default
aspectsInitiated Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set AspectsInitiated
Description:  
SETCACHEBOX
function setCacheBox
Arguments:
Name Required Type Default
cacheBox Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the application's CacheBox instance
Description:  
SETCOLDBOXINITIATED
function setColdboxInitiated
Arguments:
Name Required Type Default
coldboxInitiated Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ColdboxInitiated
Description:  
SETCOLDBOXOCM
function setColdboxOCM
Arguments:
Name Required Type Default
coldboxOCM Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ColdboxOCM
Description:  
SETCOLDBOXSETTINGS
function setColdboxSettings
Arguments:
Name Required Type Default
coldboxSettings Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ColdboxSettings
Description:  
SETCONFIGSETTINGS
function setConfigSettings
Arguments:
Name Required Type Default
configSettings Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ConfigSettings
Description:  
SETDEBUGGERSERVICE
function setDebuggerService
Arguments:
Name Required Type Default
debuggerService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set DebuggerService
Description:  
SETHANDLERSERVICE
function setHandlerService
Arguments:
Name Required Type Default
handlerService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set HandlerService
Description:  
SETINTERCEPTORSERVICE
function setInterceptorService
Arguments:
Name Required Type Default
interceptorService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set interceptorService
Description:  
SETLOADERSERVICE
function setLoaderService
Arguments:
Name Required Type Default
loaderService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set LoaderService
Description:  
SETLOG
function setLog
Arguments:
Name Required Type Default
logger Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the class logger object
Description:  
SETLOGBOX
function setLogBox
Arguments:
Name Required Type Default
logBox Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the logBox instance
Description:  
SETMODULESERVICE
function setModuleService
Arguments:
Name Required Type Default
moduleService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set ModuleService
Description:  
SETNEXTEVENT
function setNextEvent
Arguments:
Name Required Type Default
event Optional string [runtime expression]
queryString Optional string [empty string]
addToken Optional boolean false
persist Optional string [empty string]
persistStruct Optional struct [runtime expression]
ssl Optional boolean  
baseURL Optional string [empty string]
postProcessExempt Optional boolean false
URL Optional string  
URI Optional string  
statusCode Optional numeric 0
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Set the next event to run and relocate the browser to that event. If you are in SES mode, this method will use routing instead. You can also use this method to relocate to an absolute URL or a relative URI
Description:  
SETPLUGINSERVICE
function setPluginService
Arguments:
Name Required Type Default
pluginService Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set PluginService
Description:  
SETREQUESTSERVICE
function setRequestService
Arguments:
Name Required Type Default
requestService Required any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set RequestService
Description:  
SETSETTING
function setSetting
Arguments:
Name Required Type Default
name Optional any  
value Optional any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided. This only sets in the ConfigStruct
Description:  
SETTINGEXISTS
function settingExists
Arguments:
Name Required Type Default
name Required any  
FWSetting Optional any false
ReturnType: any
Roles:  
Access: public
Output: false
DisplayName:  
Hint: I Check if a value exists in the configstruct or the fwsettingsStruct.
Description:  
SETWIREBOX
function setWireBox
Arguments:
Name Required Type Default
wireBox Required Any  
ReturnType: void
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Set the WireBox instance
Description:  
UPDATESSL
function updateSSL
Arguments:
Name Required Type Default
inURL Required Any  
ssl Required Any  
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Update SSL or not on a request string
Description:  
VALIDATEACTION
function validateAction
Arguments:
Name Required Type Default
action Required any [empty string]
inclusion Optional any [empty string]
exclusion Optional any [empty string]
ReturnType: any
Roles:  
Access: private
Output: false
DisplayName:  
Hint: Checks if an action can be executed according to inclusion/exclusion lists. Boolean
Description:  
DEFAULTLAYOUT default.cfm
DEFAULTVIEW [empty string]
EVENTNAME event
FOLDERLAYOUTS
struct
*/admin admin.cfm
admin admin.cfm
ISNOEXECUTION false
ISSES true
MODULES
struct [empty]
PRIVATECONTEXT
struct
CURRENTPAGE
struct
AUTHOR ProjectTrueNorth.org
BROWSERTITLE ProjectTrueNorth.org
DESCRIPTION North Hill: a vibrant, active retirement community with luxurious residences, independent living senior apartments and the highest-quality healthcare. The next evolution in senior living - just minute
ISSEARCHABLE 1
KEYWORDS Senior Residences, Retirement homes, Senior housing, Retirement community, Retirement communities, Senior apartments, Elderly housing, Independent living, Retirement community, Active retirement communities, Senior living, Massachusetts
LANGUAGE en_US
PALETTE default
PERMALINKID [empty string]
TITLE ProjectTrueNorth.org
RESOURCES
struct
EXTERNAL
struct
CSS
array [empty]
FILES
array [empty]
JS
array [empty]
INTERNAL
struct
CSS
array [empty]
JS
array [empty]
SITE
component model.site.Site
        extends model.cms.BaseEntity
PROPERTIES
siteID TrueNorth
rootID TrueNorth
baseURL http://www.truenorthevolution.org
secureURL http://www.truenorthevolution.org
siteLocale en_US
siteTimezone Etc/GMT+12
name ProjectTrueNorth.org
description Vibrant Living at North Hill
logo [empty string]
favicon /sites/TrueNorth/uploads/favicon.ico
appletouchicon /sites/TrueNorth/uploads/favicon.png
copyright ©2012 North Hill -- All Rights Reserved
credit Site Design by <a href="http://www.creatingresults.com/" target="_blank">Creating Results, LLC</a>
metadescription North Hill: a vibrant, active retirement community with luxurious residences, independent living senior apartments and the highest-quality healthcare. The next evolution in senior living - just minute
keywords Senior Residences, Retirement homes, Senior housing, Retirement community, Retirement communities, Senior apartments, Elderly housing, Independent living, Retirement community, Active retirement communities, Senior living, Massachusetts
author ProjectTrueNorth.org
headcode <meta name="google-site-verification" content="zxUF9CcZMdYiEOOToRGhfOMcSoS01ehyCaCaNq3eWkw" />
footcode <img src="http://ad.yieldmanager.com/pixel?id=1470120&id=1470128&t=2" width="1" height="1" />
mailServerIP [empty string]
mailServerSMTPPort [empty string]
mailServerPOPPort [empty string]
mailServerUserName [empty string]
mailServerPassword [empty string]
mailServerTLS [empty string]
mailServerSSL [empty string]
mailFrom erin@creatingresults.com
GoogleAnalyticsSiteID UA-26882893-1
GoogleAPIUserName cr_support
GoogleAPIPassword gr8results!
mobileURL [empty string]
isLive YES
isProduction NO
isPrivate NO
isMatureContent NO
defaultEvent page.true-north
theme truenorth
maintenanceNotice [empty string]
emergencyNotice [empty string]
settings
struct [empty]
owner
component model.security.User
        extends model.cms.BaseEntity
PROPERTIES
userId 2efb96f2331517bb01331519da810003
username cr_support
email MJ@26NorthMedia.com
emailStatus [empty string]
password 8BC9D6BFEBB13E64ABB1CA7FF4F3BA19
confirmPassword [empty string]
passwordHasReset NO
usernamePasswordHash F6440386B3568EDA85CBB7AFA9509E638BC9D6BFEBB13E64ABB1CA7FF4F3BA19
emailPasswordHash DC771ED1D66F3A237608C6B8F96F2F598BC9D6BFEBB13E64ABB1CA7FF4F3BA19
timezone [empty string]
language [empty string]
FirstName [empty string]
LastName [empty string]
nickName [empty string]
phone [empty string]
mobile [empty string]
imageURL [empty string]
iconURL [empty string]
gender [empty string]
dateofBirth [empty string]
description [empty string]
website [empty string]
tags [empty string]
privacyMode [empty string]
status [empty string]
totalLogins [empty string]
lastLogin 2012-05-18 14:41:55.0
lastLoginIP [empty string]
lastLoginAttempt [empty string]
failedLogins [empty string]
permissions SiteAdmin,MenuEditor,MenuAuthor,PageEditor,PageAuthor,ContentEditor,ContentAuthor,EntryEditor,EntryAuthor,adminMenu,siteNotice
roles
array
1
component model.security.Role
        extends model.cms.BaseEntity
PROPERTIES
roleId 2efb96f2331517bb01331519db3d0006
name Author
site [empty string]
Users
array
1 [see cfc4 for User details]
2
component model.security.User
        extends model.cms.BaseEntity
PROPERTIES
userId 2efb96f234b8c3e20135316eff8100cf
username deslami
email deslami@northhill.org
emailStatus [empty string]
password 33AF0463BC2D0E6F750DA79650F2BFB0
confirmPassword [empty string]
passwordHasReset NO
usernamePasswordHash E673CB62C5B504D4135E3D97B08F36A833AF0463BC2D0E6F750DA79650F2BFB0
emailPasswordHash D028183322B7B3FF045901E9382FD40133AF0463BC2D0E6F750DA79650F2BFB0
timezone [empty string]
language [empty string]
FirstName [empty string]
LastName [empty string]
nickName [empty string]
phone [empty string]
mobile [empty string]
imageURL [empty string]
iconURL [empty string]
gender [empty string]
dateofBirth [empty string]
description [empty string]
website [empty string]
tags [empty string]
privacyMode [empty string]
status [empty string]
totalLogins [empty string]
lastLogin 2012-05-17 10:38:54.0
lastLoginIP [empty string]
lastLoginAttempt [empty string]
failedLogins [empty string]
permissions SiteAdmin,MenuEditor,MenuAuthor,PageEditor,PageAuthor,ContentEditor,ContentAuthor,EntryEditor,EntryAuthor,adminMenu,siteNotice
roles
array
1 [see cfc5 for Role details]
2
component model.security.Role
        extends model.cms.BaseEntity
PROPERTIES
roleId 2efb96f2331517bb01331519db5c0007
name Editor
site [empty string]
Users
array
1 [see cfc4 for User details]
2 [see cfc6 for User details]
3
component model.security.User
        extends model.cms.BaseEntity
PROPERTIES
userId 2efb96f234b8c3e20135316f8d6900d0
username dgubata
email dgubata@northhill.org
emailStatus [empty string]
password 4207EEC33A27B8A5A3F00FD982975E4F
confirmPassword [empty string]
passwordHasReset NO
usernamePasswordHash 4C82514EDBCB3E1FB86E86819C07DDC44207EEC33A27B8A5A3F00FD982975E4F
emailPasswordHash 0A2E786BBFA6D844189346AC92149DBC4207EEC33A27B8A5A3F00FD982975E4F
timezone [empty string]
language [empty string]
FirstName [empty string]
LastName [empty string]
nickName [empty string]
phone [empty string]
mobile [empty string]
imageURL [empty string]
iconURL [empty string]
gender [empty string]
dateofBirth [empty string]
description [empty string]
website [empty string]
tags [empty string]
privacyMode [empty string]
status [empty string]
totalLogins [empty string]
lastLogin 2012-02-01 15:18:00.0
lastLoginIP [empty string]
lastLoginAttempt [empty string]
failedLogins [empty string]
permissions SiteAdmin,MenuEditor,MenuAuthor,PageEditor,PageAuthor,ContentEditor,ContentAuthor,EntryEditor,EntryAuthor,adminMenu,siteNotice
roles
array
1 [see cfc5 for Role details]
2 [see cfc7 for Role details]
memberships
array [empty]
socialLinks
array [empty]
isActive YES
adminNotes [empty string]
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
ADDMEMBERSHIP
function ADDMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDROLE
function addRole
Arguments:
Name Required Type Default
Role Required Role  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDSOCIALLINK
function ADDSOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHANGEPASSWORD
function changePassword
Arguments:
Name Required Type Default
newpassword Optional string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHECKPERMISSION
function checkPermission
Arguments:
Name Required Type Default
permissionNeeded Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: check memberships and permissions list for key
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETADMINNOTES
function GETADMINNOTES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETAGE
function getAge
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCONFIRMPASSWORD
function GETCONFIRMPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDATEOFBIRTH
function GETDATEOFBIRTH
Arguments:none
ReturnType: date
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDESCRIPTION
function GETDESCRIPTION
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDISPLAYLASTLOGIN
function getDisplayLastLogin
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAIL
function GETEMAIL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILPASSWORDHASH
function GETEMAILPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILSTATUS
function GETEMAILSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFAILEDLOGINS
function GETFAILEDLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFIRSTNAME
function GETFIRSTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETGENDER
function GETGENDER
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETICONURL
function GETICONURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETIMAGEURL
function GETIMAGEURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISACTIVE
function GETISACTIVE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLANGUAGE
function GETLANGUAGE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGIN
function GETLASTLOGIN
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINATTEMPT
function GETLASTLOGINATTEMPT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINIP
function GETLASTLOGINIP
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTNAME
function GETLASTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLINK
function getLink
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMEMBERSHIPS
function GETMEMBERSHIPS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOBILE
function GETMOBILE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function getName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETNICKNAME
function GETNICKNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORD
function GETPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORDHASRESET
function GETPASSWORDHASRESET
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERMISSIONS
function GETPERMISSIONS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPHONE
function GETPHONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPRIVACYMODE
function GETPRIVACYMODE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLES
function GETROLES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLESLIST
function getRolesList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSOCIALLINKS
function GETSOCIALLINKS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSTATUS
function GETSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTAGS
function GETTAGS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTIMEZONE
function GETTIMEZONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTOTALLOGINS
function GETTOTALLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERID
function GETUSERID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAME
function GETUSERNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAMEPASSWORDHASH
function GETUSERNAMEPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETWEBSITE
function GETWEBSITE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASMEMBERSHIP
function HASMEMBERSHIP
Arguments:
Name Required Type Default
memberships Optional model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASROLE
function HASROLE
Arguments:
Name Required Type Default
roles Optional model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASSOCIALLINK
function HASSOCIALLINK
Arguments:
Name Required Type Default
socialLinks Optional model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: User
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RANDOMPASSWORD
function randomPassword
Arguments:none
ReturnType: String
Roles:  
Access: private
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEMEMBERSHIP
function REMOVEMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEROLE
function REMOVEROLE
Arguments:
Name Required Type Default
role Required model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVESOCIALLINK
function REMOVESOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:none
ReturnType: String
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETADMINNOTES
function SETADMINNOTES
Arguments:
Name Required Type Default
adminNotes Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETCONFIRMPASSWORD
function setConfirmPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDATEOFBIRTH
function SETDATEOFBIRTH
Arguments:
Name Required Type Default
dateofBirth Required date  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDESCRIPTION
function SETDESCRIPTION
Arguments:
Name Required Type Default
description Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAIL
function SETEMAIL
Arguments:
Name Required Type Default
email Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILPASSWORDHASH
function SETEMAILPASSWORDHASH
Arguments:
Name Required Type Default
emailPasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILSTATUS
function SETEMAILSTATUS
Arguments:
Name Required Type Default
emailStatus Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETFAILEDLOGINS
function SETFAILEDLOGINS
Arguments:
Name Required Type Default
failedLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETFIRSTNAME
function SETFIRSTNAME
Arguments:
Name Required Type Default
FirstName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETGENDER
function SETGENDER
Arguments:
Name Required Type Default
gender Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETICONURL
function SETICONURL
Arguments:
Name Required Type Default
iconURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETIMAGEURL
function SETIMAGEURL
Arguments:
Name Required Type Default
imageURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISACTIVE
function SETISACTIVE
Arguments:
Name Required Type Default
isActive Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLANGUAGE
function SETLANGUAGE
Arguments:
Name Required Type Default
language Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGIN
function SETLASTLOGIN
Arguments:
Name Required Type Default
lastLogin Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINATTEMPT
function SETLASTLOGINATTEMPT
Arguments:
Name Required Type Default
lastLoginAttempt Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINIP
function SETLASTLOGINIP
Arguments:
Name Required Type Default
lastLoginIP Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTNAME
function SETLASTNAME
Arguments:
Name Required Type Default
LastName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMEMBERSHIPS
function SETMEMBERSHIPS
Arguments:
Name Required Type Default
memberships Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMOBILE
function SETMOBILE
Arguments:
Name Required Type Default
mobile Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETNICKNAME
function SETNICKNAME
Arguments:
Name Required Type Default
nickName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORD
function setPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORDHASRESET
function SETPASSWORDHASRESET
Arguments:
Name Required Type Default
passwordHasReset Required boolean  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPERMISSIONS
function SETPERMISSIONS
Arguments:
Name Required Type Default
permissions Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPHONE
function SETPHONE
Arguments:
Name Required Type Default
phone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPRIVACYMODE
function SETPRIVACYMODE
Arguments:
Name Required Type Default
privacyMode Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLES
function SETROLES
Arguments:
Name Required Type Default
roles Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLESLIST
function setRolesList
Arguments:
Name Required Type Default
roles Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSOCIALLINKS
function SETSOCIALLINKS
Arguments:
Name Required Type Default
socialLinks Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSTATUS
function SETSTATUS
Arguments:
Name Required Type Default
status Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTAGS
function SETTAGS
Arguments:
Name Required Type Default
tags Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTIMEZONE
function SETTIMEZONE
Arguments:
Name Required Type Default
timezone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTOTALLOGINS
function SETTOTALLOGINS
Arguments:
Name Required Type Default
totalLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAME
function SETUSERNAME
Arguments:
Name Required Type Default
username Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAMEPASSWORDHASH
function SETUSERNAMEPASSWORDHASH
Arguments:
Name Required Type Default
usernamePasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETWEBSITE
function SETWEBSITE
Arguments:
Name Required Type Default
website Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
userCount 3
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
ADDUSER
function addUser
Arguments:
Name Required Type Default
User Required User  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CANBEDELETED
function canBeDeleted
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function GETNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLEID
function GETROLEID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSITE
function GETSITE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERCOUNT
function GETUSERCOUNT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERS
function GETUSERS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASSITE
function HASSITE
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASUSER
function HASUSER
Arguments:
Name Required Type Default
Users Optional User  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Role
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEUSER
function removeUser
Arguments:
Name Required Type Default
User Required User  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETNAME
function SETNAME
Arguments:
Name Required Type Default
name Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSITE
function SETSITE
Arguments:
Name Required Type Default
site Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERCOUNT
function SETUSERCOUNT
Arguments:
Name Required Type Default
userCount Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERS
function SETUSERS
Arguments:
Name Required Type Default
Users Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
3
component model.security.Role
        extends model.cms.BaseEntity
PROPERTIES
roleId 2efb96f2331517bb01331519db7b0008
name SiteAdmin
site [empty string]
Users
array
1 [see cfc6 for User details]
2 [see cfc4 for User details]
userCount 2
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
ADDUSER
function addUser
Arguments:
Name Required Type Default
User Required User  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CANBEDELETED
function canBeDeleted
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function GETNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLEID
function GETROLEID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSITE
function GETSITE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERCOUNT
function GETUSERCOUNT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERS
function GETUSERS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASSITE
function HASSITE
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASUSER
function HASUSER
Arguments:
Name Required Type Default
Users Optional User  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Role
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEUSER
function removeUser
Arguments:
Name Required Type Default
User Required User  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETNAME
function SETNAME
Arguments:
Name Required Type Default
name Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSITE
function SETSITE
Arguments:
Name Required Type Default
site Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERCOUNT
function SETUSERCOUNT
Arguments:
Name Required Type Default
userCount Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERS
function SETUSERS
Arguments:
Name Required Type Default
Users Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
memberships
array [empty]
socialLinks
array [empty]
isActive YES
adminNotes [empty string]
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
ADDMEMBERSHIP
function ADDMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDROLE
function addRole
Arguments:
Name Required Type Default
Role Required Role  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDSOCIALLINK
function ADDSOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHANGEPASSWORD
function changePassword
Arguments:
Name Required Type Default
newpassword Optional string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHECKPERMISSION
function checkPermission
Arguments:
Name Required Type Default
permissionNeeded Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: check memberships and permissions list for key
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETADMINNOTES
function GETADMINNOTES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETAGE
function getAge
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCONFIRMPASSWORD
function GETCONFIRMPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDATEOFBIRTH
function GETDATEOFBIRTH
Arguments:none
ReturnType: date
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDESCRIPTION
function GETDESCRIPTION
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDISPLAYLASTLOGIN
function getDisplayLastLogin
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAIL
function GETEMAIL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILPASSWORDHASH
function GETEMAILPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILSTATUS
function GETEMAILSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFAILEDLOGINS
function GETFAILEDLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFIRSTNAME
function GETFIRSTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETGENDER
function GETGENDER
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETICONURL
function GETICONURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETIMAGEURL
function GETIMAGEURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISACTIVE
function GETISACTIVE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLANGUAGE
function GETLANGUAGE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGIN
function GETLASTLOGIN
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINATTEMPT
function GETLASTLOGINATTEMPT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINIP
function GETLASTLOGINIP
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTNAME
function GETLASTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLINK
function getLink
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMEMBERSHIPS
function GETMEMBERSHIPS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOBILE
function GETMOBILE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function getName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETNICKNAME
function GETNICKNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORD
function GETPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORDHASRESET
function GETPASSWORDHASRESET
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERMISSIONS
function GETPERMISSIONS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPHONE
function GETPHONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPRIVACYMODE
function GETPRIVACYMODE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLES
function GETROLES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLESLIST
function getRolesList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSOCIALLINKS
function GETSOCIALLINKS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSTATUS
function GETSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTAGS
function GETTAGS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTIMEZONE
function GETTIMEZONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTOTALLOGINS
function GETTOTALLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERID
function GETUSERID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAME
function GETUSERNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAMEPASSWORDHASH
function GETUSERNAMEPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETWEBSITE
function GETWEBSITE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASMEMBERSHIP
function HASMEMBERSHIP
Arguments:
Name Required Type Default
memberships Optional model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASROLE
function HASROLE
Arguments:
Name Required Type Default
roles Optional model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASSOCIALLINK
function HASSOCIALLINK
Arguments:
Name Required Type Default
socialLinks Optional model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: User
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RANDOMPASSWORD
function randomPassword
Arguments:none
ReturnType: String
Roles:  
Access: private
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEMEMBERSHIP
function REMOVEMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEROLE
function REMOVEROLE
Arguments:
Name Required Type Default
role Required model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVESOCIALLINK
function REMOVESOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:none
ReturnType: String
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETADMINNOTES
function SETADMINNOTES
Arguments:
Name Required Type Default
adminNotes Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETCONFIRMPASSWORD
function setConfirmPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDATEOFBIRTH
function SETDATEOFBIRTH
Arguments:
Name Required Type Default
dateofBirth Required date  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDESCRIPTION
function SETDESCRIPTION
Arguments:
Name Required Type Default
description Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAIL
function SETEMAIL
Arguments:
Name Required Type Default
email Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILPASSWORDHASH
function SETEMAILPASSWORDHASH
Arguments:
Name Required Type Default
emailPasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILSTATUS
function SETEMAILSTATUS
Arguments:
Name Required Type Default
emailStatus Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETFAILEDLOGINS
function SETFAILEDLOGINS
Arguments:
Name Required Type Default
failedLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETFIRSTNAME
function SETFIRSTNAME
Arguments:
Name Required Type Default
FirstName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETGENDER
function SETGENDER
Arguments:
Name Required Type Default
gender Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETICONURL
function SETICONURL
Arguments:
Name Required Type Default
iconURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETIMAGEURL
function SETIMAGEURL
Arguments:
Name Required Type Default
imageURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISACTIVE
function SETISACTIVE
Arguments:
Name Required Type Default
isActive Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLANGUAGE
function SETLANGUAGE
Arguments:
Name Required Type Default
language Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGIN
function SETLASTLOGIN
Arguments:
Name Required Type Default
lastLogin Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINATTEMPT
function SETLASTLOGINATTEMPT
Arguments:
Name Required Type Default
lastLoginAttempt Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINIP
function SETLASTLOGINIP
Arguments:
Name Required Type Default
lastLoginIP Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTNAME
function SETLASTNAME
Arguments:
Name Required Type Default
LastName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMEMBERSHIPS
function SETMEMBERSHIPS
Arguments:
Name Required Type Default
memberships Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMOBILE
function SETMOBILE
Arguments:
Name Required Type Default
mobile Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETNICKNAME
function SETNICKNAME
Arguments:
Name Required Type Default
nickName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORD
function setPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORDHASRESET
function SETPASSWORDHASRESET
Arguments:
Name Required Type Default
passwordHasReset Required boolean  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPERMISSIONS
function SETPERMISSIONS
Arguments:
Name Required Type Default
permissions Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPHONE
function SETPHONE
Arguments:
Name Required Type Default
phone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPRIVACYMODE
function SETPRIVACYMODE
Arguments:
Name Required Type Default
privacyMode Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLES
function SETROLES
Arguments:
Name Required Type Default
roles Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLESLIST
function setRolesList
Arguments:
Name Required Type Default
roles Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSOCIALLINKS
function SETSOCIALLINKS
Arguments:
Name Required Type Default
socialLinks Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSTATUS
function SETSTATUS
Arguments:
Name Required Type Default
status Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTAGS
function SETTAGS
Arguments:
Name Required Type Default
tags Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTIMEZONE
function SETTIMEZONE
Arguments:
Name Required Type Default
timezone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTOTALLOGINS
function SETTOTALLOGINS
Arguments:
Name Required Type Default
totalLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAME
function SETUSERNAME
Arguments:
Name Required Type Default
username Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAMEPASSWORDHASH
function SETUSERNAMEPASSWORDHASH
Arguments:
Name Required Type Default
usernamePasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETWEBSITE
function SETWEBSITE
Arguments:
Name Required Type Default
website Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
3 [see cfc8 for User details]
userCount 3
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
ADDUSER
function addUser
Arguments:
Name Required Type Default
User Required User  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CANBEDELETED
function canBeDeleted
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function GETNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLEID
function GETROLEID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSITE
function GETSITE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERCOUNT
function GETUSERCOUNT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERS
function GETUSERS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASSITE
function HASSITE
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASUSER
function HASUSER
Arguments:
Name Required Type Default
Users Optional User  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Role
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEUSER
function removeUser
Arguments:
Name Required Type Default
User Required User  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETNAME
function SETNAME
Arguments:
Name Required Type Default
name Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSITE
function SETSITE
Arguments:
Name Required Type Default
site Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERCOUNT
function SETUSERCOUNT
Arguments:
Name Required Type Default
userCount Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERS
function SETUSERS
Arguments:
Name Required Type Default
Users Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
2 [see cfc7 for Role details]
3 [see cfc9 for Role details]
memberships
array [empty]
socialLinks
array [empty]
isActive YES
adminNotes [empty string]
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
ADDMEMBERSHIP
function ADDMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDROLE
function addRole
Arguments:
Name Required Type Default
Role Required Role  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDSOCIALLINK
function ADDSOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHANGEPASSWORD
function changePassword
Arguments:
Name Required Type Default
newpassword Optional string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHECKPERMISSION
function checkPermission
Arguments:
Name Required Type Default
permissionNeeded Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: check memberships and permissions list for key
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETADMINNOTES
function GETADMINNOTES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETAGE
function getAge
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCONFIRMPASSWORD
function GETCONFIRMPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDATEOFBIRTH
function GETDATEOFBIRTH
Arguments:none
ReturnType: date
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDESCRIPTION
function GETDESCRIPTION
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDISPLAYLASTLOGIN
function getDisplayLastLogin
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAIL
function GETEMAIL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILPASSWORDHASH
function GETEMAILPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILSTATUS
function GETEMAILSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFAILEDLOGINS
function GETFAILEDLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFIRSTNAME
function GETFIRSTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETGENDER
function GETGENDER
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETICONURL
function GETICONURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETIMAGEURL
function GETIMAGEURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISACTIVE
function GETISACTIVE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLANGUAGE
function GETLANGUAGE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGIN
function GETLASTLOGIN
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINATTEMPT
function GETLASTLOGINATTEMPT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINIP
function GETLASTLOGINIP
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTNAME
function GETLASTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLINK
function getLink
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMEMBERSHIPS
function GETMEMBERSHIPS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOBILE
function GETMOBILE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function getName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETNICKNAME
function GETNICKNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORD
function GETPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORDHASRESET
function GETPASSWORDHASRESET
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERMISSIONS
function GETPERMISSIONS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPHONE
function GETPHONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPRIVACYMODE
function GETPRIVACYMODE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLES
function GETROLES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLESLIST
function getRolesList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSOCIALLINKS
function GETSOCIALLINKS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSTATUS
function GETSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTAGS
function GETTAGS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTIMEZONE
function GETTIMEZONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTOTALLOGINS
function GETTOTALLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERID
function GETUSERID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAME
function GETUSERNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAMEPASSWORDHASH
function GETUSERNAMEPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETWEBSITE
function GETWEBSITE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASMEMBERSHIP
function HASMEMBERSHIP
Arguments:
Name Required Type Default
memberships Optional model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASROLE
function HASROLE
Arguments:
Name Required Type Default
roles Optional model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASSOCIALLINK
function HASSOCIALLINK
Arguments:
Name Required Type Default
socialLinks Optional model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: User
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RANDOMPASSWORD
function randomPassword
Arguments:none
ReturnType: String
Roles:  
Access: private
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEMEMBERSHIP
function REMOVEMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEROLE
function REMOVEROLE
Arguments:
Name Required Type Default
role Required model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVESOCIALLINK
function REMOVESOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:none
ReturnType: String
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETADMINNOTES
function SETADMINNOTES
Arguments:
Name Required Type Default
adminNotes Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETCONFIRMPASSWORD
function setConfirmPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDATEOFBIRTH
function SETDATEOFBIRTH
Arguments:
Name Required Type Default
dateofBirth Required date  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDESCRIPTION
function SETDESCRIPTION
Arguments:
Name Required Type Default
description Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAIL
function SETEMAIL
Arguments:
Name Required Type Default
email Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILPASSWORDHASH
function SETEMAILPASSWORDHASH
Arguments:
Name Required Type Default
emailPasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILSTATUS
function SETEMAILSTATUS
Arguments:
Name Required Type Default
emailStatus Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETFAILEDLOGINS
function SETFAILEDLOGINS
Arguments:
Name Required Type Default
failedLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETFIRSTNAME
function SETFIRSTNAME
Arguments:
Name Required Type Default
FirstName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETGENDER
function SETGENDER
Arguments:
Name Required Type Default
gender Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETICONURL
function SETICONURL
Arguments:
Name Required Type Default
iconURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETIMAGEURL
function SETIMAGEURL
Arguments:
Name Required Type Default
imageURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISACTIVE
function SETISACTIVE
Arguments:
Name Required Type Default
isActive Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLANGUAGE
function SETLANGUAGE
Arguments:
Name Required Type Default
language Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGIN
function SETLASTLOGIN
Arguments:
Name Required Type Default
lastLogin Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINATTEMPT
function SETLASTLOGINATTEMPT
Arguments:
Name Required Type Default
lastLoginAttempt Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINIP
function SETLASTLOGINIP
Arguments:
Name Required Type Default
lastLoginIP Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTNAME
function SETLASTNAME
Arguments:
Name Required Type Default
LastName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMEMBERSHIPS
function SETMEMBERSHIPS
Arguments:
Name Required Type Default
memberships Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMOBILE
function SETMOBILE
Arguments:
Name Required Type Default
mobile Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETNICKNAME
function SETNICKNAME
Arguments:
Name Required Type Default
nickName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORD
function setPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORDHASRESET
function SETPASSWORDHASRESET
Arguments:
Name Required Type Default
passwordHasReset Required boolean  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPERMISSIONS
function SETPERMISSIONS
Arguments:
Name Required Type Default
permissions Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPHONE
function SETPHONE
Arguments:
Name Required Type Default
phone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPRIVACYMODE
function SETPRIVACYMODE
Arguments:
Name Required Type Default
privacyMode Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLES
function SETROLES
Arguments:
Name Required Type Default
roles Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLESLIST
function setRolesList
Arguments:
Name Required Type Default
roles Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSOCIALLINKS
function SETSOCIALLINKS
Arguments:
Name Required Type Default
socialLinks Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSTATUS
function SETSTATUS
Arguments:
Name Required Type Default
status Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTAGS
function SETTAGS
Arguments:
Name Required Type Default
tags Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTIMEZONE
function SETTIMEZONE
Arguments:
Name Required Type Default
timezone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTOTALLOGINS
function SETTOTALLOGINS
Arguments:
Name Required Type Default
totalLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAME
function SETUSERNAME
Arguments:
Name Required Type Default
username Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAMEPASSWORDHASH
function SETUSERNAMEPASSWORDHASH
Arguments:
Name Required Type Default
usernamePasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETWEBSITE
function SETWEBSITE
Arguments:
Name Required Type Default
website Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETAPPLETOUCHICON
function GETAPPLETOUCHICON
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETAUTHOR
function GETAUTHOR
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETBASEURL
function GETBASEURL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCOPYRIGHT
function GETCOPYRIGHT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCREDIT
function GETCREDIT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDEFAULTEVENT
function GETDEFAULTEVENT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDESCRIPTION
function GETDESCRIPTION
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMERGENCYNOTICE
function GETEMERGENCYNOTICE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFAVICON
function GETFAVICON
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFOOTCODE
function GETFOOTCODE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETGOOGLEANALYTICSSITEID
function GETGOOGLEANALYTICSSITEID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETGOOGLEAPIPASSWORD
function GETGOOGLEAPIPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETGOOGLEAPIUSERNAME
function GETGOOGLEAPIUSERNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETHEADCODE
function GETHEADCODE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISLIVE
function GETISLIVE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISMATURECONTENT
function GETISMATURECONTENT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISPRIVATE
function GETISPRIVATE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISPRODUCTION
function GETISPRODUCTION
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETKEYWORDS
function GETKEYWORDS
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLOGO
function GETLOGO
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILFROM
function GETMAILFROM
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILSERVERIP
function GETMAILSERVERIP
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILSERVERPASSWORD
function GETMAILSERVERPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILSERVERPOPPORT
function GETMAILSERVERPOPPORT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILSERVERSMTPPORT
function GETMAILSERVERSMTPPORT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILSERVERSSL
function GETMAILSERVERSSL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILSERVERTLS
function GETMAILSERVERTLS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAILSERVERUSERNAME
function GETMAILSERVERUSERNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMAINTENANCENOTICE
function GETMAINTENANCENOTICE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMETADESCRIPTION
function GETMETADESCRIPTION
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOBILEURL
function GETMOBILEURL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function GETNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETOWNER
function GETOWNER
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROOTID
function GETROOTID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSECUREURL
function GETSECUREURL
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSETTING
function getSetting
Arguments:
Name Required Type Default
name Required Any  
value Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSETTINGS
function GETSETTINGS
Arguments:none
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSITEID
function GETSITEID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSITELOCALE
function GETSITELOCALE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSITETIMEZONE
function GETSITETIMEZONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTHEME
function GETTHEME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASOWNER
function HASOWNER
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Site
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETAPPLETOUCHICON
function SETAPPLETOUCHICON
Arguments:
Name Required Type Default
appletouchicon Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETAUTHOR
function SETAUTHOR
Arguments:
Name Required Type Default
author Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETBASEURL
function SETBASEURL
Arguments:
Name Required Type Default
baseURL Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETCOPYRIGHT
function SETCOPYRIGHT
Arguments:
Name Required Type Default
copyright Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETCREDIT
function SETCREDIT
Arguments:
Name Required Type Default
credit Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDEFAULTEVENT
function SETDEFAULTEVENT
Arguments:
Name Required Type Default
defaultEvent Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDESCRIPTION
function SETDESCRIPTION
Arguments:
Name Required Type Default
description Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMERGENCYNOTICE
function SETEMERGENCYNOTICE
Arguments:
Name Required Type Default
emergencyNotice Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETFAVICON
function SETFAVICON
Arguments:
Name Required Type Default
favicon Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETFOOTCODE
function SETFOOTCODE
Arguments:
Name Required Type Default
footcode Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETGOOGLEANALYTICSSITEID
function SETGOOGLEANALYTICSSITEID
Arguments:
Name Required Type Default
GoogleAnalyticsSiteID Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETGOOGLEAPIPASSWORD
function SETGOOGLEAPIPASSWORD
Arguments:
Name Required Type Default
GoogleAPIPassword Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETGOOGLEAPIUSERNAME
function SETGOOGLEAPIUSERNAME
Arguments:
Name Required Type Default
GoogleAPIUserName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETHEADCODE
function SETHEADCODE
Arguments:
Name Required Type Default
headcode Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISLIVE
function SETISLIVE
Arguments:
Name Required Type Default
isLive Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISMATURECONTENT
function SETISMATURECONTENT
Arguments:
Name Required Type Default
isMatureContent Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISPRIVATE
function SETISPRIVATE
Arguments:
Name Required Type Default
isPrivate Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISPRODUCTION
function SETISPRODUCTION
Arguments:
Name Required Type Default
isProduction Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETKEYWORDS
function SETKEYWORDS
Arguments:
Name Required Type Default
keywords Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLOGO
function SETLOGO
Arguments:
Name Required Type Default
logo Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILFROM
function SETMAILFROM
Arguments:
Name Required Type Default
mailFrom Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILSERVERIP
function SETMAILSERVERIP
Arguments:
Name Required Type Default
mailServerIP Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILSERVERPASSWORD
function SETMAILSERVERPASSWORD
Arguments:
Name Required Type Default
mailServerPassword Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILSERVERPOPPORT
function SETMAILSERVERPOPPORT
Arguments:
Name Required Type Default
mailServerPOPPort Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILSERVERSMTPPORT
function SETMAILSERVERSMTPPORT
Arguments:
Name Required Type Default
mailServerSMTPPort Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILSERVERSSL
function SETMAILSERVERSSL
Arguments:
Name Required Type Default
mailServerSSL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILSERVERTLS
function SETMAILSERVERTLS
Arguments:
Name Required Type Default
mailServerTLS Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAILSERVERUSERNAME
function SETMAILSERVERUSERNAME
Arguments:
Name Required Type Default
mailServerUserName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMAINTENANCENOTICE
function SETMAINTENANCENOTICE
Arguments:
Name Required Type Default
maintenanceNotice Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMETADESCRIPTION
function SETMETADESCRIPTION
Arguments:
Name Required Type Default
metadescription Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMOBILEURL
function SETMOBILEURL
Arguments:
Name Required Type Default
mobileURL Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETNAME
function SETNAME
Arguments:
Name Required Type Default
name Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETOWNER
function SETOWNER
Arguments:
Name Required Type Default
owner Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROOTID
function SETROOTID
Arguments:
Name Required Type Default
rootID Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSECUREURL
function SETSECUREURL
Arguments:
Name Required Type Default
secureURL Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSETTINGS
function SETSETTINGS
Arguments:
Name Required Type Default
settings Required struct  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSITEID
function SETSITEID
Arguments:
Name Required Type Default
siteID Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSITELOCALE
function SETSITELOCALE
Arguments:
Name Required Type Default
siteLocale Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSITETIMEZONE
function SETSITETIMEZONE
Arguments:
Name Required Type Default
siteTimezone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTHEME
function SETTHEME
Arguments:
Name Required Type Default
theme Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
USER
component model.security.User
        extends model.cms.BaseEntity
PROPERTIES
userId [empty string]
username [empty string]
email [empty string]
emailStatus [empty string]
password [empty string]
confirmPassword [empty string]
passwordHasReset false
usernamePasswordHash [empty string]
emailPasswordHash [empty string]
timezone [empty string]
language [empty string]
FirstName [empty string]
LastName [empty string]
nickName [empty string]
phone [empty string]
mobile [empty string]
imageURL [empty string]
iconURL [empty string]
gender [empty string]
dateofBirth [empty string]
description [empty string]
website [empty string]
tags [empty string]
privacyMode [empty string]
status [empty string]
totalLogins [empty string]
lastLogin [empty string]
lastLoginIP [empty string]
lastLoginAttempt [empty string]
failedLogins [empty string]
permissions [empty string]
roles
array [empty]
memberships
array [empty]
socialLinks
array [empty]
isActive true
adminNotes [empty string]
METHODS
ADDERROR
function addError
Arguments:
Name Required Type Default
Error Required Any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Add an error object. Also saves the property to a errorProperties array for quick searching.
Description:  
ADDMEMBERSHIP
function ADDMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDROLE
function addRole
Arguments:
Name Required Type Default
Role Required Role  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ADDSOCIALLINK
function ADDSOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHANGEPASSWORD
function changePassword
Arguments:
Name Required Type Default
newpassword Optional string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
CHECKPERMISSION
function checkPermission
Arguments:
Name Required Type Default
permissionNeeded Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: check memberships and permissions list for key
Description:  
CLEARERRORS
function clearErrors
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Erase all errors from the Object
Description:  
DECRYPTPROPERTIES
function decryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
DELETE
function delete
Arguments:
Name Required Type Default
flush Optional boolean false
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTPROPERTIES
function encryptProperties
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ERROREXISTS
function errorExists
Arguments:
Name Required Type Default
property Required string  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if the property is in error
Description:  
GETADMINNOTES
function GETADMINNOTES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETAGE
function getAge
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCLASSNAME
function getClassName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETCONFIRMPASSWORD
function GETCONFIRMPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDATEOFBIRTH
function GETDATEOFBIRTH
Arguments:none
ReturnType: date
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDESCRIPTION
function GETDESCRIPTION
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETDISPLAYLASTLOGIN
function getDisplayLastLogin
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAIL
function GETEMAIL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILPASSWORDHASH
function GETEMAILPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETEMAILSTATUS
function GETEMAILSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETENTITYNAME
function getEntityName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFAILEDLOGINS
function GETFAILEDLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFIRSTNAME
function GETFIRSTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETFORMATTEDCREATEDDATE
function getFormattedCreatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get formatted createdDate
Description:  
GETFORMATTEDUPDATEDDATE
function getFormattedUpdatedDate
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETGENDER
function GETGENDER
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETICONURL
function GETICONURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETID
function getID
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
GETIDENTIFIERCOLUMNNAMES
function getIdentifierColumnNames
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETIMAGEURL
function GETIMAGEURL
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETISACTIVE
function GETISACTIVE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLANGUAGE
function GETLANGUAGE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGIN
function GETLASTLOGIN
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINATTEMPT
function GETLASTLOGINATTEMPT
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTLOGINIP
function GETLASTLOGINIP
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTNAME
function GETLASTNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETLINK
function getLink
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMEMBERSHIPS
function GETMEMBERSHIPS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOBILE
function GETMOBILE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETMOMENTO
function getMomento
Arguments:
Name Required Type Default
exclude Optional string [empty string]
ReturnType: struct
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Get memento
Description:  
GETNAME
function getName
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETNICKNAME
function GETNICKNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORD
function GETPASSWORD
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPASSWORDHASRESET
function GETPASSWORDHASRESET
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERMISSIONS
function GETPERMISSIONS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPERSISTEDPROPERTIES
function getPersistedProperties
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPHONE
function GETPHONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETPRIVACYMODE
function GETPRIVACYMODE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLES
function GETROLES
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETROLESLIST
function getRolesList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSOCIALLINKS
function GETSOCIALLINKS
Arguments:none
ReturnType: array
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETSTATUS
function GETSTATUS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTAGS
function GETTAGS
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTIMEZONE
function GETTIMEZONE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETTOTALLOGINS
function GETTOTALLOGINS
Arguments:none
ReturnType: numeric
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERID
function GETUSERID
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAME
function GETUSERNAME
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERNAMEPASSWORDHASH
function GETUSERNAMEPASSWORDHASH
Arguments:none
ReturnType: string
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
GETWEBSITE
function GETWEBSITE
Arguments:none
ReturnType: any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASERRORS
function hasErrors
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Returns true if any error exist.
Description:  
HASMEMBERSHIP
function HASMEMBERSHIP
Arguments:
Name Required Type Default
memberships Optional model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASROLE
function HASROLE
Arguments:
Name Required Type Default
roles Optional model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
HASSOCIALLINK
function HASSOCIALLINK
Arguments:
Name Required Type Default
socialLinks Optional model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: User
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
ISLOADED
function isLoaded
Arguments:none
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint: is Loaded (not new)?
Description:  
POSTLOAD
function postLoad
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREINSERT
function preInsert
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
PREUPDATE
function preUpdate
Arguments:none
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RANDOMPASSWORD
function randomPassword
Arguments:none
ReturnType: String
Roles:  
Access: private
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEMEMBERSHIP
function REMOVEMEMBERSHIP
Arguments:
Name Required Type Default
membership Required model.security.Membership  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVEROLE
function REMOVEROLE
Arguments:
Name Required Type Default
role Required model.security.Role  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
REMOVESOCIALLINK
function REMOVESOCIALLINK
Arguments:
Name Required Type Default
socialLink Required model.security.SocialLink  
ReturnType: boolean
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:none
ReturnType: String
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
forceInsert Optional boolean false
flush Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SET
function set
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint: generic setter to call the set methods for each argument passed. Returns the object
Description:  
SETADMINNOTES
function SETADMINNOTES
Arguments:
Name Required Type Default
adminNotes Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETCONFIRMPASSWORD
function setConfirmPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDATEOFBIRTH
function SETDATEOFBIRTH
Arguments:
Name Required Type Default
dateofBirth Required date  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETDESCRIPTION
function SETDESCRIPTION
Arguments:
Name Required Type Default
description Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAIL
function SETEMAIL
Arguments:
Name Required Type Default
email Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILPASSWORDHASH
function SETEMAILPASSWORDHASH
Arguments:
Name Required Type Default
emailPasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETEMAILSTATUS
function SETEMAILSTATUS
Arguments:
Name Required Type Default
emailStatus Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETERRORS
function setErrors
Arguments:
Name Required Type Default
Errors Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint: Set multiple errors into the Object
Description:  
SETFAILEDLOGINS
function SETFAILEDLOGINS
Arguments:
Name Required Type Default
failedLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETFIRSTNAME
function SETFIRSTNAME
Arguments:
Name Required Type Default
FirstName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETGENDER
function SETGENDER
Arguments:
Name Required Type Default
gender Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETICONURL
function SETICONURL
Arguments:
Name Required Type Default
iconURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETIMAGEURL
function SETIMAGEURL
Arguments:
Name Required Type Default
imageURL Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETISACTIVE
function SETISACTIVE
Arguments:
Name Required Type Default
isActive Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLANGUAGE
function SETLANGUAGE
Arguments:
Name Required Type Default
language Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGIN
function SETLASTLOGIN
Arguments:
Name Required Type Default
lastLogin Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINATTEMPT
function SETLASTLOGINATTEMPT
Arguments:
Name Required Type Default
lastLoginAttempt Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTLOGINIP
function SETLASTLOGINIP
Arguments:
Name Required Type Default
lastLoginIP Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETLASTNAME
function SETLASTNAME
Arguments:
Name Required Type Default
LastName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMEMBERSHIPS
function SETMEMBERSHIPS
Arguments:
Name Required Type Default
memberships Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETMOBILE
function SETMOBILE
Arguments:
Name Required Type Default
mobile Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETNICKNAME
function SETNICKNAME
Arguments:
Name Required Type Default
nickName Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORD
function setPassword
Arguments:
Name Required Type Default
password Optional String  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPASSWORDHASRESET
function SETPASSWORDHASRESET
Arguments:
Name Required Type Default
passwordHasReset Required boolean  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPERMISSIONS
function SETPERMISSIONS
Arguments:
Name Required Type Default
permissions Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPHONE
function SETPHONE
Arguments:
Name Required Type Default
phone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETPRIVACYMODE
function SETPRIVACYMODE
Arguments:
Name Required Type Default
privacyMode Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLES
function SETROLES
Arguments:
Name Required Type Default
roles Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETROLESLIST
function setRolesList
Arguments:
Name Required Type Default
roles Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSOCIALLINKS
function SETSOCIALLINKS
Arguments:
Name Required Type Default
socialLinks Required array  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETSTATUS
function SETSTATUS
Arguments:
Name Required Type Default
status Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTAGS
function SETTAGS
Arguments:
Name Required Type Default
tags Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTIMEZONE
function SETTIMEZONE
Arguments:
Name Required Type Default
timezone Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETTOTALLOGINS
function SETTOTALLOGINS
Arguments:
Name Required Type Default
totalLogins Required numeric  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAME
function SETUSERNAME
Arguments:
Name Required Type Default
username Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETUSERNAMEPASSWORDHASH
function SETUSERNAMEPASSWORDHASH
Arguments:
Name Required Type Default
usernamePasswordHash Required string  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SETWEBSITE
function SETWEBSITE
Arguments:
Name Required Type Default
website Required any  
ReturnType: void
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
cbox_incomingContextHash 99914B932BD37A50B983C5E7C90AE93B
currentLayout default.cfm
currentRoute :stub/
currentRoutedURL photo-gallery/
currentView site.error
REGISTEREDLAYOUTS
struct
ADMIN admin.cfm
XML xml.cfm
REQUESTCONTEXT
component coldbox.system.web.context.RequestContext
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:  
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:  
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:  
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:  
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: string
Roles:  
Access: public
Output: false
DisplayName:  
Hint: Gets the current set view the framework will try to render for this request
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:none
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:  
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
properties Required any  
ReturnType: RequestContext
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:  
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 Required 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]
jsonCase Optional string lower
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]
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:  
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 Optional any  
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:  
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 string  
nolayout Optional boolean false
cache Optional boolean false
cacheTimeout Optional string [empty string]
cacheLastAccessTimeout Optional string [empty string]
cacheSuffix Optional string [empty string]
layout Optional string  
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:  
ROUTEDSTRUCT
struct
stub photo-gallery
SESBASEURL http://www.truenorthevolution.org
VIEWLAYOUTS
struct [empty]