| COMMONSPOT |
| struct |
| API |
| struct |
| ESCAPEHTML |
| function escape |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Required |
string |
|
| majorChars |
Optional |
boolean |
1 |
| newlines |
Optional |
boolean |
0 |
| multiSpaces |
Optional |
boolean |
0 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Does basic escaping of a string for presentation as HTML. |
| Description: |
|
|
|
| GETCLASSDEFS |
| function GetClassDefs |
Arguments:
| Name |
Required |
Type |
Default |
| ElementType |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns default 'ClassNames' structure for given element type |
| Description: |
|
|
|
| GETOBJECT |
| function getObject |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Returns a public api object. |
| Description: |
|
|
|
| UNESCAPEHTML |
| function unescape |
Arguments:
| Name |
Required |
Type |
Default |
| string |
Required |
string |
|
| majorChars |
Optional |
boolean |
1 |
| brTags |
Optional |
boolean |
1 |
| multiSpaces |
Optional |
boolean |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Undoes basic html escaping done by Server.CommonSpot.udf.html.escape. |
| Description: |
|
|
|
| UPDATETIMESTAMP |
1335848380663
|
|
| BACKGROUNDCACHEMANAGER |
[cfc1] component
commonspot.components.util.background-cache-manager
extends
commonspot.components.base-component
|
| LIMIT_TO_SCALABILITY_MAX |
-1
|
| METHODS |
| ALLOCATEITEMS |
| function allocateItems |
Arguments:
| Name |
Required |
Type |
Default |
| SiteID |
Required |
numeric |
|
| ItemsToAllocate |
Optional |
numeric |
10 |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
allocate items for a specific server/site combination, returning the new total number of items assigned |
| Description: |
|
|
|
| CALLMETHOD |
| function callMethod |
Arguments:
| Name |
Required |
Type |
Default |
| methodName |
Required |
string |
|
| Args |
Optional |
any |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
wrapper method to make sure remote calls are correctly scoped |
| Description: |
|
|
|
| CFABORT |
| function cfAbort |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKTHREADCONTINUATION |
| function checkThreadContinuation |
Arguments:
| Name |
Required |
Type |
Default |
| SiteID |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns true if a thread processing items for given SiteID should continue |
| Description: |
|
|
|
| DBG |
| function dbg |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Optional |
any |
_THIS_ARGUMENT_WAS_NOT_PASSED_ |
| scope |
Optional |
struct |
[runtime expression] |
| showLocation |
Optional |
boolean |
no |
| showAsHTML |
Optional |
boolean |
no |
| clear |
Optional |
boolean |
no |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Dev debug function, appends passed args to array aDbg in requested scope for readout purposes. If one argument named 'value' is passed, only, then its value alone will be appended. Otherwise, all named args besides config ones listed below are appended as a struct. Something needs to show it; dashboard cmd toolkit does automatically, other situations needs to roll their own, by calling someObject.dbgReadout(). To see queries from within a dashboard cmd, set showAsHTML true, and they'll show below the main result display. Non-html dbg calls get inserted into cmd result status, so display goes through serialization and back, and that doesn't support queries. |
| Description: |
|
|
|
| DBGREADOUT |
| function dbgReadout |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Optional |
struct |
[runtime expression] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
yes |
| DisplayName: |
|
| Hint: |
Dev debug readout; see dbg(). |
| Description: |
|
|
|
| GETALLOCATEDITEM |
| function getAllocatedItem |
Arguments:
| Name |
Required |
Type |
Default |
| SiteID |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns next PageID to process for given SiteID. Returns zero if nothing left in queue |
| Description: |
|
|
|
| GETDSN |
| function getDSN |
Arguments:
| Name |
Required |
Type |
Default |
| dsnType |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns name of requested CommonSpot DSN. |
| Description: |
|
|
|
| GETDUMP |
| function getDump |
Arguments:
| Name |
Required |
Type |
Default |
| var |
Optional |
any |
[empty string] |
| label |
Optional |
Any |
[empty string] |
| expand |
Optional |
Any |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Dev tool; returns cfdump of requested var. Can pass either arguments.var (or un-named first argument) or arguments.varPath. varPath is resolved using StructGet, and can refer to private internal data. |
| Description: |
|
|
|
| GETERRORMSG |
| function getErrorMsg |
Arguments:
| Name |
Required |
Type |
Default |
| reasonCode |
Required |
string |
|
| msgParam1 |
Optional |
string |
[runtime expression] |
| msgParam2 |
Optional |
string |
[runtime expression] |
| msgParam3 |
Optional |
string |
[runtime expression] |
| msgParam4 |
Optional |
string |
[runtime expression] |
| msgParam5 |
Optional |
string |
[runtime expression] |
| msgParam6 |
Optional |
string |
[runtime expression] |
| msgParam7 |
Optional |
string |
[runtime expression] |
| msgParam8 |
Optional |
string |
[runtime expression] |
| msgParam9 |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Looks up the error message corresponding to a passed error code |
| Description: |
|
|
|
| GETHASHCODE |
| function getHashCode |
Arguments:
| Name |
Required |
Type |
Default |
| obj |
Optional |
any |
[runtime expression] |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns hash identifier of an object, defaulting to 'this'. NEEDSWORK: This recreates java system object every time; that lets it be used before object factory is set up, but if we use this a lot, do something else. |
| Description: |
|
|
|
| GETLOCKNAME |
| function getLockName |
Arguments:
| Name |
Required |
Type |
Default |
| ThreadID |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the lock name to use for the given thread ID |
| Description: |
|
|
|
| GETNEXTSITEID |
| function getNextSiteID |
| Arguments: | none |
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns SiteID of next unallocated item in queue, zero if nothing in queue |
| Description: |
|
|
|
| GETSITESTATUS |
| function getSiteStatus |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a struct (keyed by SiteID) containing structures with the number of allocated and unallocated pending items for each site |
| Description: |
|
|
|
| GETTASKNAME |
| function getTaskName |
Arguments:
| Name |
Required |
Type |
Default |
| ThreadID |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the task name to use for the given thread ID |
| Description: |
|
|
|
| GETTHREADSTATUS |
| function getThreadStatus |
| Arguments: | none |
| ReturnType: |
array
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns array of status structures, one per available thread |
| Description: |
|
|
|
| GETVAR |
| function getVar |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Dev tool; returns any complex value, given path to it. |
| Description: |
|
|
|
| GETVARIABLESDATA |
| function getVariablesData |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct w a list of all vars in the variables space, and for any of those that are components that have this method defined, a struct with the names of NEEDSWORK. |
| Description: |
|
|
|
| INIT |
| function init |
| Arguments: | none |
| ReturnType: |
ANY
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Pseudo-constructor. |
| Description: |
|
|
|
| PICK |
| function pick |
Arguments:
| Name |
Required |
Type |
Default |
| bool |
Required |
boolean |
|
| choice1 |
Required |
any |
|
| choice2 |
Required |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| QUEUECACHEUPDATE |
| function queueCacheUpdate |
Arguments:
| Name |
Required |
Type |
Default |
| SiteID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
| RequestedAction |
Optional |
string |
update |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
queue an update request for the given SiteID/PageID |
| Description: |
|
|
|
| REMOVEITEM |
| function removeItem |
Arguments:
| Name |
Required |
Type |
Default |
| SiteID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
removes item from queue, presumably because we're done with it |
| Description: |
|
|
|
| SCHEDULEQUEUES |
| function scheduleQueues |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
schedules background queues as appropriate |
| Description: |
|
|
|
| SETTESTMODE |
| function setTestMode |
Arguments:
| Name |
Required |
Type |
Default |
| newTestMode |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
sets 'test mode' flag |
| Description: |
|
|
|
| SETUP |
| function setup |
Arguments:
| Name |
Required |
Type |
Default |
| UseDatabase |
Required |
boolean |
|
| DSN |
Required |
string |
|
| ServerID |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
initialize this component |
| Description: |
|
|
|
| STRUCTMAKE |
| function structMake |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct populated with passed arguments. |
| Description: |
|
|
|
| THROWCMDREFUSALCODE |
| function throwCmdRefusalCode |
Arguments:
| Name |
Required |
Type |
Default |
| reasonCode |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Throws a command refusal error exception given an error code. |
| Description: |
|
|
|
| THROWINTERNALERRORCODE |
| function throwInternalErrorCode |
Arguments:
| Name |
Required |
Type |
Default |
| reasonCode |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Throws an internal error exception given an error code. |
| Description: |
|
|
|
| UPDATEMAXTHREADS |
| function updateMaxThreads |
Arguments:
| Name |
Required |
Type |
Default |
| maxThreads |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
updates the max number of background threads to use |
| Description: |
|
|
|
| WRITEDUMPFILE |
| function writeDumpFile |
Arguments:
| Name |
Required |
Type |
Default |
| var |
Required |
any |
|
| file |
Required |
string |
|
| label |
Optional |
string |
[empty string] |
| append |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Writes cfdump of requested var to requested file. |
| Description: |
|
|
|
|
|
| CFADMINDS |
| [cfc2] component
commonspot.components.admin-api-cf.datasource-cf8
|
| METHODS |
| DELETEDATASOURCE |
| function deleteDataSource |
Arguments:
| Name |
Required |
Type |
Default |
| dsnname |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Delete the specified data source |
| Description: |
|
|
|
| GETCFDATASOURCEOBJECT |
| function getCFDatasourceObject |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the appropriate native object |
| Description: |
|
|
|
| GETDATASOURCE |
| function getDatasource |
Arguments:
| Name |
Required |
Type |
Default |
| dsnname |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Return a specified data source |
| Description: |
|
|
|
| GETDATASOURCES |
| function getDatasources |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Return an array containing all the data sources |
| Description: |
|
|
|
| SETMSSQL |
| function setMSSQL |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| description |
Optional |
string |
[empty string] |
| servername |
Required |
string |
|
| databasename |
Required |
string |
|
| username |
Optional |
string |
[empty string] |
| password |
Optional |
string |
[empty string] |
| port |
Optional |
numeric |
1433 |
| UTF8Enabled |
Optional |
boolean |
false |
| IsReadOnly |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Set a MS SQL Server data source |
| Description: |
|
|
|
| SETMYSQL |
| function setMySQL |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| description |
Optional |
string |
[empty string] |
| servername |
Required |
string |
|
| databasename |
Required |
string |
|
| username |
Optional |
string |
[empty string] |
| password |
Optional |
string |
[empty string] |
| port |
Optional |
numeric |
3306 |
| UTF8Enabled |
Optional |
boolean |
false |
| IsReadOnly |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set a MySQL data source |
| Description: |
|
|
|
| SETORACLE |
| function setOracle |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| description |
Optional |
string |
[empty string] |
| servername |
Required |
string |
|
| databasename |
Required |
string |
|
| username |
Optional |
string |
[empty string] |
| password |
Optional |
string |
[empty string] |
| port |
Optional |
numeric |
1521 |
| UTF8Enabled |
Optional |
boolean |
false |
| IsReadOnly |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set an Oracle data source |
| Description: |
|
|
|
| SETPOSTGRESQL |
| function setPostgreSQL |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| description |
Optional |
string |
[empty string] |
| servername |
Required |
string |
|
| databasename |
Required |
string |
|
| username |
Optional |
string |
[empty string] |
| password |
Optional |
string |
[empty string] |
| port |
Optional |
numeric |
5432 |
| UTF8Enabled |
Optional |
boolean |
false |
| IsReadOnly |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set a PostgreSQL data source |
| Description: |
|
|
|
| VERIFYDSN |
| function verifyDsn |
Arguments:
| Name |
Required |
Type |
Default |
| dsn |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Verify the specified data source |
| Description: |
|
|
|
|
|
| CFADMINISTRATOR |
[cfc3] component
cfide.adminapi.administrator
extends
cfide.adminapi.base
|
| METHODS |
| DUMP |
| function dump |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
Any |
|
| expand |
Optional |
Any |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Used to debug variables inside of cfscript. |
| Description: |
|
|
|
| GETADMINPROPERTY |
| function getAdminProperty |
Arguments:
| Name |
Required |
Type |
Default |
| propertyName |
Required |
Any |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns Migration Wizard or Setup Wizard status. |
| Description: |
|
|
|
| GETEDITION |
| function getEdition |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
package |
| Output: |
No |
| DisplayName: |
|
| Hint: |
Returns the edition: - Developer
- Evaluation
Standard- Enterprise
- Professional
|
| Description: |
|
|
|
| GETINSTALLTYPE |
| function getInstallType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
package |
| Output: |
No |
| DisplayName: |
|
| Hint: |
Returns the install type. |
| Description: |
|
|
|
| GETJRUNROOTDIR |
| function getJRunRootDir |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGRATECF5FLAG |
| function getMigrateCF5Flag |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETMIGRATECF6FLAG |
| function getMigrateCF6Flag |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETMIGRATECF7FLAG |
| function getMigrateCF7Flag |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETMIGRATECF8FLAG |
| function getMigrateCF8Flag |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETMIGRATIONFLAG |
| function getMigrationFlag |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the ColdFusion 5 to ColdFusion Migration Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETMXMIGRATIONFLAG |
| function getMXMigrationFlag |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the ColdFusion MX to ColdFusion 8 Migration Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETSALT |
| function getSalt |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
remote |
| Output: |
|
| DisplayName: |
|
| Hint: |
Get salt from server for Administrator login. |
| Description: |
|
|
|
| GETSETUPENABLERDS |
| function getSetupEnableRDS |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETSETUPODBC |
| function getSetupOdbc |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETSETUPSAMPLEAPPS |
| function getSetupSampleApps |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| GETSETUPWIZARDFLAG |
| function getSetupWizardFlag |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Indicates whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| ISADMINUSER |
| function isAdminUser |
Arguments:
| Name |
Required |
Type |
Default |
| requiredRoles |
Optional |
Any |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Check to see if user is authenticated |
| Description: |
|
|
|
| LOGIN |
| function login |
Arguments:
| Name |
Required |
Type |
Default |
| adminPassword |
Required |
Any |
|
| adminUserId |
Optional |
Any |
[runtime expression] |
| salt |
Optional |
Any |
|
| rdsPasswordAllowed |
Optional |
Any |
false |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
remote |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Authenticate the user for the length of the request. Required before accessing other methods of the Administrator API. Returns true if login successful. |
| Description: |
|
|
|
| LOGOUT |
| function logout |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
remote |
| Output: |
|
| DisplayName: |
|
| Hint: |
Logout from the Administrator API. |
| Description: |
|
|
|
| RDSINVOKER |
| function RDSInvoker |
Arguments:
| Name |
Required |
Type |
Default |
| service |
Required |
Any |
|
| method |
Required |
Any |
|
| args |
Required |
Any |
|
| adminPassword |
Required |
Any |
|
| adminUserId |
Required |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Used internally to invoke the Administrator API from Dreamweaver. |
| Description: |
|
|
|
| SETADMINPROPERTY |
| function setAdminProperty |
Arguments:
| Name |
Required |
Type |
Default |
| propertyName |
Required |
Any |
|
| propertyValue |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Sets Migration Wizard or Setup Wizard status. |
| Description: |
|
|
|
| SETJRUNSN |
| function setJrunSN |
Arguments:
| Name |
Required |
Type |
Default |
| serialNum |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
package |
| Output: |
No |
| DisplayName: |
|
| Hint: |
Utility function that sets the JRun OEM serial number. |
| Description: |
|
|
|
| SETMIGRATECF5FLAG |
| function setMigrateCF5Flag |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETMIGRATECF6FLAG |
| function setMigrateCF6Flag |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETMIGRATECF7FLAG |
| function setMigrateCF7Flag |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETMIGRATECF8FLAG |
| function setMigrateCF8Flag |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETMIGRATIONFLAG |
| function setMigrationFlag |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the ColdFusion 5 to ColdFusion Migration Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETMXMIGRATIONFLAG |
| function setMXMigrationFlag |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the ColdFusion MX to ColdFusion 8 Migration Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETSETUPENABLERDS |
| function setSetupEnableRDS |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETSETUPODBC |
| function setSetupOdbc |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETSETUPSAMPLEAPPS |
| function setSetupSampleApps |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
| SETSETUPWIZARDFLAG |
| function setSetupWizardFlag |
Arguments:
| Name |
Required |
Type |
Default |
| flag |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Specifies whether the Setup Wizard should run when starting the ColdFusion Administrator for the first/next time. |
| Description: |
|
|
|
|
|
| CFEXTENSIONS |
[cfc4] component
cfide.adminapi.extensions
extends
cfide.adminapi.base
|
| METHODS |
| DELETEAPPLET |
| function deleteApplet |
Arguments:
| Name |
Required |
Type |
Default |
| appletName |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Deletes the specified applet. |
| Description: |
|
|
|
| DELETECFX |
| function deleteCFX |
Arguments:
| Name |
Required |
Type |
Default |
| cfxname |
Optional |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Deletes a CFX tag. |
| Description: |
|
|
|
| DELETECORBACONNECTOR |
| function deleteCorbaConnector |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Removes a CORBA Connector from the set of registered ColdFusion CORBA Connectors. |
| Description: |
|
|
|
| DELETECUSTOMTAGPATH |
| function deleteCustomTagPath |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Deletes a custom tag path |
| Description: |
|
|
|
| DELETEMAPPING |
| function deleteMapping |
Arguments:
| Name |
Required |
Type |
Default |
| mapName |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Deletes the specified ColdFusion mapping. |
| Description: |
|
|
|
| DELETEWEBSERVICE |
| function deleteWebService |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Deletes a ColdFusion web service. |
| Description: |
|
|
|
| DUMP |
| function dump |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
Any |
|
| expand |
Optional |
Any |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Used to debug variables inside of cfscript. |
| Description: |
|
|
|
| GETAPPLETS |
| function getApplets |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Return a list of all registered Java applets or a specified applet. |
| Description: |
|
|
|
| GETCFX |
| function getCFX |
Arguments:
| Name |
Required |
Type |
Default |
| cfxname |
Optional |
Any |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Lists the names of all registered CFX tags or a specified CFX tag. |
| Description: |
|
|
|
| GETCORBACONNECTORS |
| function getCorbaConnectors |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Retrieves name, path, and options for CORBA Connectors. |
| Description: |
|
|
|
| GETCUSTOMTAGPATHS |
| function getCustomTagPaths |
| Arguments: | none |
| ReturnType: |
array
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of paths to custom tags. |
| Description: |
|
|
|
| GETEDITION |
| function getEdition |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
package |
| Output: |
No |
| DisplayName: |
|
| Hint: |
Returns the edition: - Developer
- Evaluation
Standard- Enterprise
- Professional
|
| Description: |
|
|
|
| GETINSTALLTYPE |
| function getInstallType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
package |
| Output: |
No |
| DisplayName: |
|
| Hint: |
Returns the install type. |
| Description: |
|
|
|
| GETJRUNROOTDIR |
| function getJRunRootDir |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMAPPINGS |
| function getMappings |
Arguments:
| Name |
Required |
Type |
Default |
| mapName |
Optional |
Any |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns ColdFusion mappings, which equate logical paths to directory paths. |
| Description: |
|
|
|
| GETUSEORB |
| function getUseOrb |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Gets the name of a CORBA Object Request Broker (ORB) to use as the default. |
| Description: |
|
|
|
| GETWEBSERVICES |
| function getWebServices |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Optional |
Any |
|
| includeAutoRegistered |
Optional |
boolean |
false |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a structure that lists all registered ColdFusion web services or a specified web service. |
| Description: |
|
|
|
| ISADMINUSER |
| function isAdminUser |
Arguments:
| Name |
Required |
Type |
Default |
| requiredRoles |
Optional |
Any |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Check to see if user is authenticated |
| Description: |
|
|
|
| RDSINVOKER |
| function RDSInvoker |
Arguments:
| Name |
Required |
Type |
Default |
| service |
Required |
Any |
|
| method |
Required |
Any |
|
| args |
Required |
Any |
|
| adminPassword |
Required |
Any |
|
| adminUserId |
Required |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Used internally to invoke the Administrator API from Dreamweaver. |
| Description: |
|
|
|
| RELOADWEBSERVICE |
| function reloadWebService |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
| path |
Required |
Any |
|
| username |
Optional |
Any |
[empty string] |
| password |
Optional |
Any |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Reloads a ColdFusion web service. |
| Description: |
|
|
|
| SETAPPLET |
| function setApplet |
Arguments:
| Name |
Required |
Type |
Default |
| applet |
Optional |
struct |
|
| appletName |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Registers a new Java applet. |
| Description: |
|
|
|
| SETCORBACONNECTOR |
| function setCorbaConnector |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
| oldname |
Optional |
Any |
|
| classname |
Required |
Any |
|
| classpath |
Required |
Any |
|
| propertyfile |
Optional |
Any |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Registers a CORBA Connector. |
| Description: |
|
|
|
| SETCPPCFX |
| function setCPPCFX |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
| library |
Required |
Any |
|
| description |
Optional |
Any |
[empty string] |
| cache |
Optional |
boolean |
true |
| procedure |
Optional |
Any |
ProcessTagRequest |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Registers a C++ CFX tag. |
| Description: |
|
|
|
| SETCUSTOMTAGPATH |
| function setCustomTagPath |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Defines a new path to custom tags. |
| Description: |
|
|
|
| SETJAVACFX |
| function setJavaCFX |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
| classname |
Required |
Any |
|
| description |
Optional |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Registers a Java CFX tag. |
| Description: |
|
|
|
| SETJRUNSN |
| function setJrunSN |
Arguments:
| Name |
Required |
Type |
Default |
| serialNum |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
package |
| Output: |
No |
| DisplayName: |
|
| Hint: |
Utility function that sets the JRun OEM serial number. |
| Description: |
|
|
|
| SETMAPPING |
| function setMapping |
Arguments:
| Name |
Required |
Type |
Default |
| mapName |
Required |
Any |
|
| mapPath |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Creates a ColdFusion mapping, equating a logical path to a directory path. |
| Description: |
|
|
|
| SETUSEORB |
| function setUseOrb |
Arguments:
| Name |
Required |
Type |
Default |
| useOrb |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Sets the name of a CORBA ORB to use as the default. |
| Description: |
|
|
|
| SETWEBSERVICE |
| function setWebService |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
| path |
Required |
Any |
|
| username |
Optional |
Any |
[empty string] |
| password |
Optional |
Any |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Adds a ColdFusion web service. |
| Description: |
|
|
|
| VALIDATEMAPPING |
| function validatemapping |
Arguments:
| Name |
Required |
Type |
Default |
| mapName |
Required |
Any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Verifies that a map name (logical path) follows the naming rules. |
| Description: |
|
|
|
|
|
| CLASSNAMESBINDINGS |
| struct |
| 1 |
BBarClassNames
|
| 10 |
LabelClassNames
|
| 11 |
TableClassNames
|
| 12 |
LBarClassNames
|
| 13 |
LinkListClassNames
|
| 15 |
MSClassNames
|
| 16 |
ObjectClassNames
|
| 17 |
PgIndexClassNames
|
| 18 |
PresClassNames
|
| 19 |
ContainerClassNames
|
| 2 |
BLClassNames
|
| 20 |
SFClassNames
|
| 21 |
SRClassNames
|
| 22 |
TabBarClassNames
|
| 23 |
TasksClassNames
|
| 24 |
TAIClassNames
|
| 25 |
TBClassNames
|
| 26 |
WebProcClassNames
|
| 28 |
ForumsClassNames
|
| 29 |
QBEClassNames
|
| 3 |
ScriptClassNames
|
| 30 |
FacetNavClassNames
|
| 31 |
CustomElementClassNames
|
| 4 |
SimpFormClassNames
|
| 5 |
DSClassNames
|
| 6 |
DateClassNames
|
| 7 |
MenuClassNames
|
| 8 |
HTMLClassNames
|
| 9 |
ImgClassNames
|
|
| CS_JavaUtils |
object of com.paperthin.common.util.CS_JavaUtils
|
| Class Name |
com.paperthin.common.util.CS_JavaUtils |
| Methods |
| Method
|
Return Type
|
| cloneObject(java.lang.Object) |
java.lang.Object |
| convertByteArrayToHexString(byte[]) |
java.lang.String |
| convertJavaArrayToCFArray(java.lang.Object[]) |
java.util.Vector |
| csLS2BR(java.lang.String) |
java.lang.String |
| getCanonicalDirWithSlash(java.lang.String) |
java.lang.String |
| getCanonicalFileName(java.lang.String) |
java.lang.String |
| getCanonicalFileNameByOS(java.lang.String) |
java.lang.String |
| getDataStreamOutput(java.io.InputStream) |
java.lang.String |
| getDumpClass(java.lang.Object) |
java.lang.String |
| getFileDetails(java.util.List) |
java.util.List |
| getFileLength(java.lang.String) |
long |
| getFileParent(java.lang.String) |
java.lang.String |
| getFileParentByOS(java.lang.String) |
java.lang.String |
| getProductVersion() |
java.lang.String |
| getServerSchemaVersion() |
java.lang.String |
| getSiteSchemaVersion() |
java.lang.String |
| getStoredObj(java.lang.String) |
java.lang.Object |
| getUsersSchemaVersion() |
java.lang.String |
| initialCustomScriptBySQL(java.sql.Connection, java.lang.String, java.lang.String) |
void |
| initialSiteBySQL(java.sql.Connection, java.lang.String, java.lang.String) |
void |
| isInstanceOf(java.lang.Object, java.lang.String) |
boolean |
| isSymbolicLink(java.lang.String) |
boolean |
| isUNCpath(java.lang.String) |
boolean |
| listToListCollection(java.lang.String, boolean) |
java.util.Vector |
| listToListCollection(java.lang.String, boolean, boolean) |
java.util.Vector |
| listToListCollection(java.lang.String, boolean, boolean, java.lang.String) |
java.util.Vector |
| listToListCollection(java.lang.String, boolean, boolean, java.lang.String, java.lang.String, int) |
java.util.Vector |
| listToListCollection(java.lang.String) |
java.util.Vector |
| resetStoredObjs() |
void |
| setStoredObj(java.lang.String, java.lang.Object) |
void |
| splitListToArray(java.lang.String, java.lang.String) |
java.util.Vector |
| unzipFile(java.lang.String, java.lang.String, boolean) |
boolean |
| zipFiles(java.util.List, java.lang.String) |
java.util.List |
| zipFilesExt(java.util.List, java.lang.String, java.lang.String) |
java.util.List |
|
|
| Constants |
object of com.paperthin.common.CS_Constants
|
| Class Name |
com.paperthin.common.CS_Constants |
| Fields |
| Field
|
Value
|
| java.lang.String ANY_XSL_TEMPLATE |
|
| java.lang.String ASP_LT_Percent |
<%
|
| java.lang.String ASP_Percent_GT |
%>
|
| java.lang.String BLOCK_DELIMITER_STRING |
-- !!~~!!~~!!~~!!~~!!~~!!~~!!
|
| java.lang.String BROWSER_REQ_DESC |
For Simple Form, requires IE 5.0, Mozilla 1.7, or higher.
|
| java.lang.String CFFileNameConflictValues |
ERROR,SKIP,OVERWRITE,MAKEUNIQUE
|
| java.lang.String CF_COMMENT_BEGIN |
|
| int CacheClear |
2
|
| int CacheExpire |
1
|
| int DeviceHTTP_Local |
1
|
| int DeviceHTTP_None |
0
|
| int DeviceHTTP_Remote |
2
|
| int DeviceNotShared |
0
|
| int DeviceShared |
1
|
| java.lang.String DistantFutureTimestamp |
2276-07-04 21:00:00
|
| int DynamicContentAutoDetect |
2
|
| int DynamicContentAutoDynamic |
3
|
| int DynamicContentAutoStatic |
4
|
| int DynamicContentAutoUnknown |
2
|
| int DynamicContentErrorDetected |
99
|
| int DynamicContentMandatoryDynamic |
5
|
| int DynamicContentManualDynamic |
1
|
| int DynamicContentManualStatic |
0
|
| java.lang.String ENDTAG_QUOTE |
"/>
|
| java.lang.String ENDTAG_XSL10NS |
|
| java.lang.String END_XSL_TEMPLATE |
|
| int EventIntervalDaily |
2
|
| int EventIntervalMinute |
1
|
| int EventIntervalMonthly |
4
|
| int EventIntervalWeekly |
3
|
| int ExprTypeCustomElementComplex |
4
|
| int ExprTypeCustomElementSimple |
3
|
| int ExprTypePgIndexComplex |
2
|
| int ExprTypePgIndexSimple |
1
|
| int ExprTypeStaticList |
0
|
| java.lang.String FieldList_ItemPermissions |
Read,Author,Edit,Design,Approve,Admin,History,Style
|
| int FileReplicateAll |
1
|
| int FileReplicateDynamic |
3
|
| int FileReplicateNone |
0
|
| int FileReplicateStatic |
2
|
| java.lang.String FontSizes |
xx-small,x-small,small,medium,large,x-large,xx-large
|
| java.lang.String INPUTPARAMSRESTOREKEY |
CommonSpotInputParamsRestoreKey
|
| java.lang.String INPUTPARAMSRESTOREKEYS |
CommonSpotInputParamsRestoreKeys
|
| com.paperthin.common.CS_Constants$jobdef_constants JobDef |
com.paperthin.common.CS_Constants$jobdef_constants
|
| byte KEYWORD_TYPE_ANY |
-1
|
| byte KEYWORD_TYPE_KEYWORD |
0
|
| byte KEYWORD_TYPE_SUBSITE_DEFAULT |
1
|
| byte KEYWORD_TYPE_SUBSITE_ENFORCED |
2
|
| byte KEYWORD_TYPE_SUBSITE_PERMANENT |
3
|
| byte KEYWORD_TYPE_TAG |
100
|
| java.lang.String LINE_SEPARATOR |
|
| com.paperthin.common.CS_Constants$LRUCache_defaults LRUCache_Default_Config |
com.paperthin.common.CS_Constants$LRUCache_defaults
|
| java.lang.String LongAgoTimestamp |
1993-11-04 01:00:00
|
| int ObjectChangeImage |
1
|
| int ObjectChangePage |
2
|
| int ObjectChangeSubsite |
3
|
| java.lang.String PSEUDO_NULL |
|\| |_| |_ |_
|
| int PgIndexPerf_Author |
0
|
| int PgIndexPerf_Author_Read |
2
|
| int PgIndexPerf_Edit_Read |
1
|
| int PgIndexPerf_Read |
3
|
| int QueryByExample |
0
|
| java.lang.String ROOT_XSL_TEMPLATE |
|
| int SSLPort |
443
|
| java.lang.String STARTTAG_XSL10NS |
|
| java.lang.String SUBSITE_SCOPE_ALL |
ALL
|
| java.lang.String SUBSITE_SCOPE_CURRENT |
CURRENT
|
| java.lang.String SUBSITE_SCOPE_CURRENT_AND_ABOVE |
CURRENT_AND_ABOVE
|
| java.lang.String SUBSITE_SCOPE_CURRENT_AND_BELOW |
CURRENT_AND_BELOW
|
| java.lang.String SUBSITE_SCOPE_CURRENT_HIERARCHY |
CURRENT_HIERARCHY
|
| java.lang.String SUBSITE_SCOPE_NONE |
NONE
|
| char SYMBOL_GT |
>
|
| char SYMBOL_LT |
<
|
| char SYMBOL_QUOTE |
"
|
| char SYMBOL_SLASH |
/
|
| byte SavedSearchType_CustomElement |
1
|
| byte SavedSearchType_Image |
2
|
| byte SavedSearchType_Page |
0
|
| int ScriptQueueBackground_Multiple |
2
|
| int ScriptQueueBackground_Single |
1
|
| int ScriptQueueForeground |
0
|
| int SecurityChangeCustomElement |
7
|
| int SecurityChangeElement |
6
|
| int SecurityChangeElementUse |
9
|
| int SecurityChangeFormat |
8
|
| int SecurityChangeOther |
99
|
| int SecurityChangePage |
5
|
| int SecurityChangeSubsiteContent |
2
|
| int SecurityChangeSubsitePerms |
1
|
| int SecurityChangeTemplateDefault |
4
|
| int SecurityChangeTemplateEnforced |
3
|
| int ServerCacheBuilder |
4
|
| int ServerClusterMaster |
0
|
| int ServerClusterSlave |
1
|
| int ServerReplicationMaster |
2
|
| int ServerReplicationTarget |
3
|
| int ServerStateDown |
1
|
| int ServerStateError |
2
|
| int ServerStateOK |
0
|
| int ServerUninitialized |
9999
|
| int SiteActive |
1
|
| int SiteInProgress |
99
|
| int SiteInactive |
0
|
| int SiteIsReadOnlyReplica |
3
|
| int SiteIsWritableReplica |
2
|
| com.paperthin.common.CS_Constants$validation_constants Validation |
com.paperthin.common.CS_Constants$validation_constants
|
| java.lang.String Win1252Chars_Chars |
,,,,
,,,,,,,,,,,,,,,,,,,,,,
|
| java.lang.String Win1252Chars_HTMLEntities |
€,‚,ƒ,„,…,†,‡,ˆ,‰,Š,‹,Œ,&ZCaron;,‘,’,“,”,•,–,—,˜,™,š,›,œ,ž,Ÿ
|
| java.lang.String Win1252Chars_NumericEntities |
€,‚,ƒ,„,…,†,‡,ˆ,‰,Š,‹,Œ,Ž,‘,’,“,”,•,–,—,˜,™,š,›,œ,ž,Ÿ
|
| java.lang.String Win1252Chars_UnicodeChars |
€,‚,ƒ,„,…,†,‡,ˆ,‰,Š,‹,Œ,Ž,‘,’,“,”,•,–,—,˜,™,š,›,œ,ž,Ÿ
|
| java.lang.String XML10HEAD |
|
| java.lang.String XSL_COPY_OF |
byte action_add |
0
|
| byte action_change |
1
|
| byte action_del |
2
|
| byte action_del_template |
4
|
| byte action_del_template_local |
3
|
| int action_layout_base |
1024
|
| int action_layout_changeProp |
1056
|
| int action_layout_deleteCol |
1026
|
| int action_layout_deleteRow |
1025
|
| int action_layout_hideCell |
2048
|
| int action_layout_insertCol |
1032
|
| int action_layout_insertRow |
1028
|
| int action_layout_moveCol |
1152
|
| int action_layout_moveRow |
1088
|
| int action_layout_shuffle |
1040
|
| int action_layout_template_delAll |
1536
|
| int action_layout_template_delLocal |
1280
|
| byte action_move |
100
|
| byte action_move_change |
101
|
| byte action_move_del |
102
|
| byte action_move_del_template |
104
|
| byte action_move_del_template_local |
103
|
| int appStateAPPROVED |
1
|
| int appStateBYPASSED |
2
|
| int appStateNOAPPROVAL |
0
|
| int cacheActionClearAll |
2
|
| int cacheActionClearSubSite |
1
|
| int cacheActionNone |
0
|
| int cacheControlSITE |
-2
|
| int cacheControlTEMPLATE |
-1
|
| byte cacheIndexCached |
2
|
| byte cacheIndexExplicit |
0
|
| byte cacheIndexNone |
1
|
| byte cachePrintCached |
2
|
| byte cachePrintExplicit |
0
|
| byte cachePrintNone |
1
|
| byte cacheSharePage |
0
|
| byte cacheShareSubsite |
1
|
| byte cacheShareTemplate |
2
|
| java.lang.String cfmlDefaultSearchServiceName |
CfmlSearchService
|
| java.lang.String cgiVarNames |
SERVER_SOFTWARE,SERVER_NAME,GATEWAY_INTERFACE,SERVER_PROTOCOL,SERVER_PORT,REQUEST_METHOD,PATH_INFO,PATH_TRANSLATED,SCRIPT_NAME,QUERY_STRING,REMOTE_HOST,REMOTE_ADDR,AUTH_TYPE,REMOTE_USER,AUTH_USER,REMOTE_IDENT,CONTENT_TYPE,CONTENT_LENGTH,HTTP_REFERER,HTTP_USER_AGENT,HTTP_IF_MODIFIED_SINCE,CERT_SUBJECT,CERT_ISSUER,CLIENT_CERT_ENCODED
|
| int changeScopeElement |
3
|
| int changeScopePage |
0
|
| int changeScopePageIndirect |
2
|
| int changeScopeSite |
5
|
| int changeScopeSubSite |
4
|
| int changeScopeTemplate |
1
|
| java.lang.String csCookiePrefix |
CSCOOKIE_
|
| java.lang.String csTextBlockElementControlType |
3,4,7,8
|
| int dfvFieldvalueColumnMax |
425
|
| int dirReplicateAlways |
1
|
| int dirReplicateMajor |
0
|
| int dirReplicateNext |
2
|
| int elementBREADCRUMBS |
39
|
| int elementBULLETEDLIST |
6
|
| int elementBULLETEDLISTOFTEXTBLOCKS |
25
|
| int elementCCF |
26
|
| int elementCONTAINER |
51
|
| int elementCUSTOMFORM |
46
|
| int elementCustomScript |
26
|
| int elementDATASHEET |
45
|
| int elementDATE |
40
|
| int elementDHTMLMENU |
47
|
| int elementDROPDOWNLIST |
21
|
| int elementFACETNAV |
52
|
| int elementFEEDINDEX |
53
|
| int elementFLASH |
34
|
| int elementFORUM |
48
|
| int elementFORUMCOMPONENTS |
49
|
| int elementHTML |
28
|
| int elementIMAGE |
9
|
| int elementIMAGEGRID |
22
|
| int elementIMAGE_NOHDR |
10
|
| int elementITERATION |
32
|
| int elementLABELS |
30
|
| int elementLAYOUT |
1
|
| int elementLINK |
20
|
| int elementLINKBAR |
23
|
| int elementMULTISECTION |
2
|
| int elementMaxFactory |
400
|
| int elementPAGEINDEX |
36
|
| int elementPAGESET_INDEX |
43
|
| int elementPAGESET_NAV |
42
|
| int elementPAGESET_TOC |
41
|
| int elementPDF |
18
|
| int elementPPPRES |
17
|
| int elementQUERYBYEXAMPLE |
50
|
| int elementQUICKTIME |
54
|
| int elementSCHEDULE |
31
|
| int elementSEARCHFORM |
38
|
| int elementSEARCHRESULTS |
37
|
| int elementSHOCKWAVE |
35
|
| int elementSIMPLETEXTBLOCK |
7
|
| int elementSIMPLETEXTBLOCK_NOHDR |
8
|
| int elementTABBAR |
29
|
| int elementTAI |
11
|
| int elementTASK |
44
|
| int elementTEXTBLOCK |
3
|
| int elementTEXTBLOCK_NOHDR |
4
|
| int elementVIDEO |
16
|
| int elementWEBPROCESS |
27
|
| int elementWORDCONVERT |
33
|
| java.lang.String iconPathBaseTemplate |
/commonspot/dashboard/images/type_icons/pgtype_2.png
|
| java.lang.String iconPathCustomControl |
/commonspot/dashboard/images/type_icons/pgtype_4.png
|
| java.lang.String iconPathCustomObjectDef |
/commonspot/dashboard/images/type_icons/pgtype_9.png
|
| java.lang.String iconPathExternalFile |
/commonspot/dashboard/images/type_icons/pgtype_7.png
|
| java.lang.String iconPathImage |
/commonspot/dashboard/images/type_icons/pgtype_3.png
|
| java.lang.String iconPathNormal |
/commonspot/dashboard/images/type_icons/pgtype_0.png
|
| java.lang.String iconPathPageSet |
/commonspot/dashboard/images/type_icons/pgtype_6.png
|
| java.lang.String iconPathRegisteredURL |
/commonspot/dashboard/images/type_icons/pgtype_8.png
|
| java.lang.String iconPathSnippet |
/commonspot/dashboard/images/type_icons/pgtype_12.png
|
| java.lang.String iconPathSubsite |
/commonspot/dashboard/images/type_icons/pgtype_5.png
|
| java.lang.String iconPathTaxonomy |
/commonspot/dashboard/images/type_icons/pgtype_10.png
|
| java.lang.String iconPathUserTemplate |
/commonspot/dashboard/images/type_icons/pgtype_1.png
|
| java.lang.String iconPathXMLPublication |
/commonspot/dashboard/images/type_icons/pgtype_11.png
|
| java.lang.String iconTextBaseTemplate |
Base Template
|
| java.lang.String iconTextCustomControl |
Custom Element
|
| java.lang.String iconTextCustomObjectDef |
Custom Object Definition
|
| java.lang.String iconTextExternalFile |
External File
|
| java.lang.String iconTextImage |
Image
|
| java.lang.String iconTextNormal |
CommonSpot Page
|
| java.lang.String iconTextPageSet |
Page Set
|
| java.lang.String iconTextRegisteredURL |
Registered URL
|
| java.lang.String iconTextSnippet |
Snippet
|
| java.lang.String iconTextSubsite |
Subsite
|
| java.lang.String iconTextTaxonomy |
Taxonomy
|
| java.lang.String iconTextUserTemplate |
Template
|
| java.lang.String iconTextXMLPublication |
XML Publication
|
| int isPublicAll |
9
|
| int isPublicPageFinder |
2
|
| int isPublicPageGallery |
4
|
| int isPublicPageIndex |
1
|
| int isPublicSearch |
8
|
| int isPublicToolsAndReports |
2
|
| int linkIgnore |
3
|
| int linkInvalid |
2
|
| int linkSyntaxValid |
4
|
| byte linkTypeDiffLang |
14
|
| byte linkTypeExternal |
2
|
| byte linkTypeExternalEmbedded |
12
|
| byte linkTypeExternalImage |
5
|
| byte linkTypeExternalObject |
8
|
| byte linkTypeExternalURL |
13
|
| byte linkTypeFuseTalk |
9
|
| byte linkTypeInternal |
1
|
| byte linkTypeInternalEmbedded |
11
|
| byte linkTypeInternalImage |
4
|
| byte linkTypeMailTo |
3
|
| byte linkTypePopupMenu |
10
|
| byte linkTypeUnregExternalURL |
15
|
| byte linkTypeUnregInternalImage |
6
|
| byte linkTypeUnregInternalObject |
7
|
| int linkUnchecked |
5
|
| int linkUnknown |
0
|
| int linkValid |
1
|
| int logAll |
2
|
| int logDisabled |
0
|
| java.lang.String logLevels |
ALL,DEBUG,INFO,WARN,ERROR,FATAL,OFF
|
| int logSelected |
1
|
| int metadataCategory |
2
|
| int metadataCustomElement |
6
|
| int metadataDocType |
3
|
| int metadataImage |
8
|
| int metadataRegisteredURL |
9
|
| int metadataRenderHandler |
7
|
| int metadataSubsite |
4
|
| int metadataTemplate |
1
|
| int metadataUnbound |
5
|
| int metadataXMLPublication |
10
|
| int nameUseALL |
2
|
| int nameUseSTYLE |
0
|
| int nameUseXML |
1
|
| int nodeClassDATA |
0
|
| int nodeClassPARAMS |
1
|
| int pgTypeBaseTemplate |
2
|
| int pgTypeCustomControl |
4
|
| int pgTypeCustomObjectDef |
9
|
| int pgTypeExternalFile |
7
|
| int pgTypeImage |
3
|
| int pgTypeMaxFactory |
400
|
| int pgTypeNormal |
0
|
| int pgTypePageSet |
6
|
| int pgTypeRegisteredURL |
8
|
| int pgTypeSiteSecurity |
5
|
| int pgTypeSnippet |
12
|
| int pgTypeSubsiteSecurity |
5
|
| int pgTypeTaxonomy |
10
|
| int pgTypeUserTemplate |
1
|
| int pgTypeXMLPublication |
11
|
| byte reminderActionDismiss |
2
|
| byte reminderActionNone |
0
|
| byte reminderActionSnooze |
1
|
| byte reminderDate |
1
|
| byte reminderExpiration |
2
|
| byte reminderStale |
2
|
| byte rphaseAll |
5
|
| byte rphaseAllCache |
5
|
| byte rphaseElementComplete |
70
|
| byte rphaseEverything |
0
|
| byte rphaseFiltered |
30
|
| byte rphaseInitial |
20
|
| byte rphasePageComplete |
90
|
| byte rphasePreRenderStruct |
40
|
| byte rphasePreRenderXML |
50
|
| byte rphaseRaw |
10
|
| byte rphaseStaticPage |
100
|
| byte rphaseStubFile |
2
|
| byte rphaseXMLPublication |
60
|
| byte shortcutAddGCEData |
5
|
| byte shortcutAddImage |
3
|
| byte shortcutAddRegisteredURL |
2
|
| byte shortcutAddUploadedDocument |
4
|
| byte shortcutCreatePage |
1
|
| int stateCURRENT |
2
|
| int stateHISTORY |
1
|
| int stateNEEDAPPROVAL |
5
|
| int stateREJECTED |
0
|
| int stateWIP |
3
|
| int stateWIPRefer |
4
|
| int tplPermBLOCK |
3
|
| int tplPermDEFAULT |
2
|
| int tplPermDEFAULTBLOCK |
5
|
| int tplPermENFORCE |
1
|
| int tplPermENFORCEBLOCK |
4
|
| int tplPermGRANTOWNERADMIN |
6
|
| int tplPermOBJECT |
0
|
| int transferFTP |
0
|
| int transferHTTP |
0
|
| int transferUNC |
0
|
|
|
| DATASOURCEINFO |
|
| DATASOURCES |
| struct |
| commonspot-aaanet |
| struct |
| SCHEMAVERSION |
2011-07-01 15:00:00
|
| TYPE |
SQLServer
|
| UDF |
| struct |
| CASTTEXTASVARCHAR |
| function CastTextAsVarchar |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| GETDBTYPE |
| function getDBType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the DB type this package is built for |
| Description: |
|
|
|
| ISEMPTY |
| function IsEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsEmpty SQL Statement |
| Description: |
|
|
|
| ISNOTEMPTY |
| function IsNotEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsNotEmpty SQL Statement |
| Description: |
|
|
|
| LITERALSTRING |
| function LiteralString |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| inString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| SUBSTRINGMETHOD |
| function SubStringMethod |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
returns name of database-platform-specific 'substring' method for use in queries |
| Description: |
|
|
|
|
| USESNVARCHARFIELDS |
1
|
| USE_FUNCTIONS |
0
|
| UTF8ENABLED |
1
|
| VERSION |
10.0.4064
|
|
| commonspot-sites |
| struct |
| SCHEMAVERSION |
2011-05-27 17:00:00
|
| TYPE |
SQLServer
|
| UDF |
| struct |
| CASTTEXTASVARCHAR |
| function CastTextAsVarchar |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| GETDBTYPE |
| function getDBType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the DB type this package is built for |
| Description: |
|
|
|
| ISEMPTY |
| function IsEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsEmpty SQL Statement |
| Description: |
|
|
|
| ISNOTEMPTY |
| function IsNotEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsNotEmpty SQL Statement |
| Description: |
|
|
|
| LITERALSTRING |
| function LiteralString |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| inString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| SUBSTRINGMETHOD |
| function SubStringMethod |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
returns name of database-platform-specific 'substring' method for use in queries |
| Description: |
|
|
|
|
| USESNVARCHARFIELDS |
1
|
| USE_FUNCTIONS |
0
|
| UTF8ENABLED |
1
|
| VERSION |
10.0.4064
|
|
| commonspot-users |
| struct |
| SCHEMAVERSION |
2011-05-27 17:00:00
|
| TYPE |
SQLServer
|
| UDF |
| struct |
| CASTTEXTASVARCHAR |
| function CastTextAsVarchar |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| GETDBTYPE |
| function getDBType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the DB type this package is built for |
| Description: |
|
|
|
| ISEMPTY |
| function IsEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsEmpty SQL Statement |
| Description: |
|
|
|
| ISNOTEMPTY |
| function IsNotEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsNotEmpty SQL Statement |
| Description: |
|
|
|
| LITERALSTRING |
| function LiteralString |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| inString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| SUBSTRINGMETHOD |
| function SubStringMethod |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
returns name of database-platform-specific 'substring' method for use in queries |
| Description: |
|
|
|
|
| USESNVARCHARFIELDS |
1
|
| USE_FUNCTIONS |
0
|
| UTF8ENABLED |
1
|
| VERSION |
10.0.4064
|
|
|
| ExceptionManager |
object of com.paperthin.common.CSRuntimeExceptionFactory
|
| Class Name |
com.paperthin.common.CSRuntimeExceptionFactory |
| Methods |
| Method
|
Return Type
|
| throwAuthenticationException(java.lang.String) |
void |
| throwAuthoringSuspendedException(java.lang.String) |
void |
| throwCSIncompleteReturnValueException(java.lang.String, java.lang.String, java.lang.Object) |
void |
| throwCommandException(java.lang.String, int) |
void |
| throwCommandException(java.lang.String) |
void |
| throwContextException(java.lang.String) |
void |
| throwContextException(java.lang.String, int) |
void |
| throwInternalException(java.lang.String, int) |
void |
| throwInternalException(java.lang.String, int, java.lang.Throwable) |
void |
| throwInternalException(java.lang.String, int, java.lang.Object) |
void |
| throwInternalException(java.lang.String) |
void |
| throwInvalidReturnValueException(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int) |
void |
| throwInvalidReturnValueException(java.lang.String, java.lang.String, java.lang.String, java.lang.String) |
void |
| throwMissingArgumentException(java.lang.String, java.lang.String, java.lang.String, int) |
void |
| throwMissingArgumentException(java.lang.String, java.lang.String, java.lang.String) |
void |
| throwSecurityException(java.lang.String) |
void |
| throwSecurityException(java.lang.String, int) |
void |
| throwValidationException(java.lang.String, java.lang.String, java.lang.Object) |
void |
|
|
| INSTANCESTARTUPTIMESTAMP |
2012-05-01 00:59:57
|
| JavaObjectFactory |
object of com.paperthin.common.services.ObjectFactory
|
| Class Name |
com.paperthin.common.services.ObjectFactory |
| Methods |
| Method
|
Return Type
|
| getFieldTypesMap(short) |
java.util.Map |
| newPageCacheStatus(int) |
com.paperthin.common.cachestatus.PageCacheStatus |
| newSecurityItem() |
com.paperthin.common.security.SecurityItem |
| newSecurityItem(com.paperthin.common.security.SecurityItem) |
com.paperthin.common.security.SecurityItem |
|
|
| MapFactory |
object of com.paperthin.common.services.MapFactory
|
| Class Name |
com.paperthin.common.services.MapFactory |
| Methods |
| Method
|
Return Type
|
| deserialize(java.lang.String) |
java.lang.Object |
| getNewInstance(java.lang.String) |
java.lang.Object |
| isBean(java.lang.Object) |
boolean |
| serialize(java.lang.Object, java.lang.String, boolean) |
java.lang.String |
|
|
| NextQueueCheck |
2012-05-16 17:35:24
|
| OBJECTFACTORY |
[cfc5] component
commonspot.components.util.object-factory
extends
commonspot.components.base-component
|
| LIMIT_TO_SCALABILITY_MAX |
-1
|
| METHODS |
| CALLMETHOD |
| function callMethod |
Arguments:
| Name |
Required |
Type |
Default |
| methodName |
Required |
string |
|
| Args |
Optional |
any |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
wrapper method to make sure remote calls are correctly scoped |
| Description: |
|
|
|
| CAPWORD |
| function capWord |
Arguments:
| Name |
Required |
Type |
Default |
| string |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns initial capped version of passed string. |
| Description: |
|
|
|
| CFABORT |
| function cfAbort |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DBG |
| function dbg |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Optional |
any |
_THIS_ARGUMENT_WAS_NOT_PASSED_ |
| scope |
Optional |
struct |
[runtime expression] |
| showLocation |
Optional |
boolean |
no |
| showAsHTML |
Optional |
boolean |
no |
| clear |
Optional |
boolean |
no |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Dev debug function, appends passed args to array aDbg in requested scope for readout purposes. If one argument named 'value' is passed, only, then its value alone will be appended. Otherwise, all named args besides config ones listed below are appended as a struct. Something needs to show it; dashboard cmd toolkit does automatically, other situations needs to roll their own, by calling someObject.dbgReadout(). To see queries from within a dashboard cmd, set showAsHTML true, and they'll show below the main result display. Non-html dbg calls get inserted into cmd result status, so display goes through serialization and back, and that doesn't support queries. |
| Description: |
|
|
|
| DBGREADOUT |
| function dbgReadout |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Optional |
struct |
[runtime expression] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
yes |
| DisplayName: |
|
| Hint: |
Dev debug readout; see dbg(). |
| Description: |
|
|
|
| GETCONSTRUCTORARGS |
| function getConstructorArgs |
Arguments:
| Name |
Required |
Type |
Default |
| objName |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns struct of all resolved constructorArgs for requested object. |
| Description: |
|
|
|
| GETDASHBOARDTARGETS |
| function getDashboardTargets |
| Arguments: | none |
| ReturnType: |
array
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of the CommonSpot components that can be called through the dashboard cmd interface. Names returned are how they're known by the CommonSpot ObjectFactory, not full cfc paths. |
| Description: |
|
|
|
| GETDSN |
| function getDSN |
Arguments:
| Name |
Required |
Type |
Default |
| dsnType |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns name of requested CommonSpot DSN. |
| Description: |
|
|
|
| GETDUMP |
| function getDump |
Arguments:
| Name |
Required |
Type |
Default |
| var |
Optional |
any |
[empty string] |
| label |
Optional |
Any |
[empty string] |
| expand |
Optional |
Any |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Dev tool; returns cfdump of requested var. Can pass either arguments.var (or un-named first argument) or arguments.varPath. varPath is resolved using StructGet, and can refer to private internal data. |
| Description: |
|
|
|
| GETERRORMSG |
| function getErrorMsg |
Arguments:
| Name |
Required |
Type |
Default |
| reasonCode |
Required |
string |
|
| msgParam1 |
Optional |
string |
[runtime expression] |
| msgParam2 |
Optional |
string |
[runtime expression] |
| msgParam3 |
Optional |
string |
[runtime expression] |
| msgParam4 |
Optional |
string |
[runtime expression] |
| msgParam5 |
Optional |
string |
[runtime expression] |
| msgParam6 |
Optional |
string |
[runtime expression] |
| msgParam7 |
Optional |
string |
[runtime expression] |
| msgParam8 |
Optional |
string |
[runtime expression] |
| msgParam9 |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Looks up the error message corresponding to a passed error code |
| Description: |
|
|
|
| GETHASHCODE |
| function getHashCode |
Arguments:
| Name |
Required |
Type |
Default |
| obj |
Optional |
any |
[runtime expression] |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns hash identifier of an object, defaulting to 'this'. NEEDSWORK: This recreates java system object every time; that lets it be used before object factory is set up, but if we use this a lot, do something else. |
| Description: |
|
|
|
| GETOBJECT |
| function getObject |
Arguments:
| Name |
Required |
Type |
Default |
| objName |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns an instance of requested object. |
| Description: |
|
|
|
| GETOBJECTRAW |
| function getObjectRaw |
Arguments:
| Name |
Required |
Type |
Default |
| objSpecs |
Optional |
any |
[empty string] |
| objName |
Optional |
string |
[empty string] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a raw instance of requested object, from its name or object specs struct. Cache is neither read nor written to, its init method isn't called, and no dependencies are injected. |
| Description: |
|
|
|
| GETOBJECTSPECS |
| function getObjectSpecs |
Arguments:
| Name |
Required |
Type |
Default |
| objName |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct with specs for a requested registered object. |
| Description: |
|
|
|
| GETVAR |
| function getVar |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Dev tool; returns any complex value, given path to it. |
| Description: |
|
|
|
| GETVARIABLESDATA |
| function getVariablesData |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct w a list of all vars in the variables space, and for any of those that are components that have this method defined, a struct with the names of NEEDSWORK. |
| Description: |
|
|
|
| INIT |
| function init |
| Arguments: | none |
| ReturnType: |
ANY
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Pseudo-constructor. |
| Description: |
|
|
|
| INITCACHE |
| function initCache |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Sets up the object cache used by the Object Factory. |
| Description: |
|
|
|
| INITOBJECTDEFS |
| function initObjectDefs |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Defines objects that getObject can return. |
| Description: |
|
|
|
| INSTANTIATEALLOBJECTS |
| function instantiateAllObjects |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Dev test method, tries to instantiate all registered objects, to make sure that's possible. |
| Description: |
|
|
|
| PICK |
| function pick |
Arguments:
| Name |
Required |
Type |
Default |
| bool |
Required |
boolean |
|
| choice1 |
Required |
any |
|
| choice2 |
Required |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REGISTERCONSTRUCTORARG |
| function registerConstructorArg |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
any |
|
| getFromFactory |
Optional |
boolean |
0 |
| name |
Required |
string |
|
| objNames |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Registers an argument to be passed to an object's constructor when it's created. Use type='object' for objects to be created by getObject(). Can pass a comma delimited list of ObjectFactory objects in arguments.objNames, to inject the same object into all of them. |
| Description: |
|
|
|
| REGISTERGENERATEDOBJECT |
| function registerGeneratedObject |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| path |
Required |
string |
|
| useCache |
Required |
boolean |
|
| hasDashboardCmds |
Optional |
string |
[empty string] |
| constructorArgs |
Optional |
string |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Registers a generated object by name, for use by getObject method or as an object constructor argument. NOTE: Arguments.useCache=true creates a cached server-scope singleton, instantiated at startup. |
| Description: |
|
|
|
| REGISTEROBJECT |
| function registerObject |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| type |
Required |
string |
|
| path |
Required |
string |
|
| useCache |
Required |
boolean |
|
| skipInit |
Optional |
boolean |
0 |
| hasDashboardCmds |
Optional |
string |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Registers an object by name, with its type ('java' or 'component') and path, for use by getObject method or as an object constructor argument. NOTE: Arguments.useCache=true creates a cached server-scope singleton, instantiated at startup. |
| Description: |
|
|
|
| STRUCTMAKE |
| function structMake |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct populated with passed arguments. |
| Description: |
|
|
|
| THROWCMDREFUSALCODE |
| function throwCmdRefusalCode |
Arguments:
| Name |
Required |
Type |
Default |
| reasonCode |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Throws a command refusal error exception given an error code. |
| Description: |
|
|
|
| THROWINTERNALERRORCODE |
| function throwInternalErrorCode |
Arguments:
| Name |
Required |
Type |
Default |
| reasonCode |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Throws an internal error exception given an error code. |
| Description: |
|
|
|
| WRITEDUMPFILE |
| function writeDumpFile |
Arguments:
| Name |
Required |
Type |
Default |
| var |
Required |
any |
|
| file |
Required |
string |
|
| label |
Optional |
string |
[empty string] |
| append |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Writes cfdump of requested var to requested file. |
| Description: |
|
|
|
|
|
| RootDir |
c:/inetpub/shared/commonspot/
|
| SEARCHSERVICENAME |
CfmlSearchService
|
| TYPEFACTORY |
[undefined struct element]
|
| UDF |
| struct |
| DB |
| struct |
| mysql |
| struct |
| CASTTEXTASVARCHAR |
| function CastTextAsVarchar |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| GETDBTYPE |
| function getDBType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the DB type this package is built for |
| Description: |
|
|
|
| ISEMPTY |
| function IsEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsEmpty SQL Statement |
| Description: |
|
|
|
| ISNOTEMPTY |
| function IsNotEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsNotEmpty SQL Statement |
| Description: |
|
|
|
| LITERALSTRING |
| function LiteralString |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| inString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| SUBSTRINGMETHOD |
| function SubStringMethod |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
returns name of database-platform-specific 'substring' method for use in queries |
| Description: |
|
|
|
|
| oracle |
| struct |
| CASTTEXTASVARCHAR |
| function CastTextAsVarchar |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| GETDBTYPE |
| function getDBType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the DB type this package is built for |
| Description: |
|
|
|
| ISEMPTY |
| function IsEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsEmpty SQL Statement |
| Description: |
|
|
|
| ISNOTEMPTY |
| function IsNotEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsNotEmpty SQL Statement |
| Description: |
|
|
|
| LITERALSTRING |
| function LiteralString |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| inString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| SUBSTRINGMETHOD |
| function SubStringMethod |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
returns name of database-platform-specific 'substring' method for use in queries |
| Description: |
|
|
|
|
| postgresql |
| struct |
| CASTTEXTASVARCHAR |
| function CastTextAsVarchar |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| GETDBTYPE |
| function getDBType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the DB type this package is built for |
| Description: |
|
|
|
| ISEMPTY |
| function IsEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsEmpty SQL Statement |
| Description: |
|
|
|
| ISNOTEMPTY |
| function IsNotEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsNotEmpty SQL Statement |
| Description: |
|
|
|
| LITERALSTRING |
| function LiteralString |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| inString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| SUBSTRINGMETHOD |
| function SubStringMethod |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
returns name of database-platform-specific 'substring' method for use in queries |
| Description: |
|
|
|
|
| sqlserver |
| struct |
| CASTTEXTASVARCHAR |
| function CastTextAsVarchar |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| GETDBTYPE |
| function getDBType |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the DB type this package is built for |
| Description: |
|
|
|
| ISEMPTY |
| function IsEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsEmpty SQL Statement |
| Description: |
|
|
|
| ISNOTEMPTY |
| function IsNotEmpty |
Arguments:
| Name |
Required |
Type |
Default |
| colname |
Required |
string |
|
| isMemoCol |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
IsNotEmpty SQL Statement |
| Description: |
|
|
|
| LITERALSTRING |
| function LiteralString |
Arguments:
| Name |
Required |
Type |
Default |
| dataSourceName |
Required |
string |
|
| inString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
adds a CAST expression if needed |
| Description: |
|
|
|
| SUBSTRINGMETHOD |
| function SubStringMethod |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
returns name of database-platform-specific 'substring' method for use in queries |
| Description: |
|
|
|
|
|
| TAGTOOLS |
object of com.paperthin.common.html.TagTools
|
| Class Name |
com.paperthin.common.html.TagTools |
| Methods |
| Method
|
Return Type
|
| FindTags(java.lang.String, java.lang.String, java.lang.String) |
com.paperthin.common.validation.ValidatedArray |
| FindTags(java.lang.String, java.lang.String) |
com.paperthin.common.validation.ValidatedArray |
| FindTags(java.lang.String, java.lang.String, java.lang.String, boolean) |
com.paperthin.common.validation.ValidatedArray |
| GetAttribute(java.lang.String, java.lang.String) |
java.util.Map |
| ParseAttributes(java.lang.String) |
com.paperthin.common.validation.ValidatedArray |
| RebuildRTEBlock(java.lang.String, java.util.List) |
java.lang.String |
| RenderTag(java.util.Map) |
java.lang.String |
| buildTagRegex(java.lang.String, java.lang.String, boolean) |
java.lang.String |
| stripColdFusionComments(java.lang.String) |
java.lang.String |
|
|
| UPDATETIMESTAMP |
1335848380632
|
| VALIDATION |
| struct |
| context |
| struct |
| Authoring |
| function Authoring |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| AuthoringEnabled |
| function AuthoringEnabled |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CacheServer |
| function CacheServer |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ClusterMaster |
| function ClusterMaster |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ClusterROPS |
| function ClusterROPS |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ROPS |
| function ROPS |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ReplicationROPS |
| function ReplicationROPS |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| core |
| struct |
| CHECKCONTEXT |
| function CheckContext |
Arguments:
| Name |
Required |
Type |
Default |
| License |
Required |
string |
|
| RequireContext |
Required |
string |
|
| DenyContext |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKPARENTVALIDATORS |
| function CheckParentValidators |
Arguments:
| Name |
Required |
Type |
Default |
| testVal |
Required |
any |
|
| validatorStack |
Required |
any |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKRETURNVALUE |
| function checkReturnValue |
Arguments:
| Name |
Required |
Type |
Default |
| testVal |
Required |
any |
|
| returnType |
Required |
string |
|
| methodName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKSECURITY |
| function CheckSecurity |
Arguments:
| Name |
Required |
Type |
Default |
| AuthorLock |
Required |
string |
|
| Permissions |
Required |
string |
|
| Args |
Required |
struct |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DOARRAYFINALVALIDATION |
| function DoArrayFinalValidation |
Arguments:
| Name |
Required |
Type |
Default |
| workArray |
Required |
array |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DOSTRUCTFINALVALIDATION |
| function DoStructFinalValidation |
Arguments:
| Name |
Required |
Type |
Default |
| workStruct |
Required |
struct |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ENSUREVALIDATEDSTRUCT |
| function ensureValidatedStruct |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Required |
struct |
|
| varName |
Required |
string |
|
| structType |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETKNOWNFEATURELIST |
| function getKnownFeatureList |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISGROUPADMIN |
| function isGroupAdmin |
Arguments:
| Name |
Required |
Type |
Default |
| groupID |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns 'true' if the current user can admin the given group |
| Description: |
|
|
|
| ISUSERADMIN |
| function isUserAdmin |
Arguments:
| Name |
Required |
Type |
Default |
| userID |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns 'true' if the current user can admin the given user |
| Description: |
|
|
|
| LOADVALIDATOR |
| function loadValidator |
Arguments:
| Name |
Required |
Type |
Default |
| validatorName |
Optional |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
loader for CF validator - if none found, use 'missingValidator' instead |
| Description: |
|
|
|
| LOGMISSINGVALIDATOR |
| function logMissingValidator |
Arguments:
| Name |
Required |
Type |
Default |
| validatorName |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
fake validator to use if we don't find a real definition |
| Description: |
|
|
|
| MISSINGVALIDATOR |
| function missingValidator |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
fake validator to use if we don't find a real definition |
| Description: |
|
|
|
| PASSUNSPECIFIEDPARAMS |
| function passUnspecifiedParams |
Arguments:
| Name |
Required |
Type |
Default |
| validatedParams |
Required |
struct |
|
| passedParams |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REJECTEXTRAPARAMS |
| function rejectExtraParams |
Arguments:
| Name |
Required |
Type |
Default |
| methodName |
Required |
string |
|
| valErrors |
Required |
struct |
|
| expectedParams |
Required |
struct |
|
| passedParams |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETSUBSITECONTEXTFROMOBJECT |
| function setSubsiteContextFromObject |
Arguments:
| Name |
Required |
Type |
Default |
| subsiteContextType |
Required |
string |
|
| objectIDorURL |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| keys |
| struct |
| FullTextIndex |
| function FullTextIndex |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
maps to 'Verity' in license key |
| Description: |
|
|
|
|
| security |
| struct |
| Authenticated |
| function Authenticated |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| Contributor |
| function Contributor |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ContributorOrServerCode |
| function ContributorOrServerCode |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UpdateSavedSearch |
| function UpdateSavedSearch |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UpdateShortcut |
| function UpdateShortcut |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UserAdminOrContributorManager |
| function UserAdminOrContributorManager |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| validators |
| struct |
| ACTIVECONTACTTYPEID |
| function ActiveContactTypeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'ActiveContactTypeID' |
| Description: |
|
|
|
| ADVANCEDIMAGESEARCHORDERBYSPEC |
| function AdvancedImageSearchOrderBySpec |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'AdvancedImageSearchOrderBySpec' |
| Description: |
|
|
|
| ADVANCEDSEARCHORDERBYSPEC |
| function AdvancedSearchOrderBySpec |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'AdvancedSearchOrderBySpec' |
| Description: |
|
|
|
| APPROVALLEVEL_EXISTINGOR1PLUSMAX |
| function ApprovalLevel_ExistingOr1PlusMax |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'ApprovalLevel_ExistingOr1PlusMax' |
| Description: |
|
|
|
| APPROVALLEVEL_NONEXISTING |
| function ApprovalLevel_NonExisting |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'ApprovalLevel_NonExisting' |
| Description: |
|
|
|
| AnyCustomerID |
| function AnyCustomerID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in HostingCustomers.ID |
| Description: |
|
|
|
| AnySiteID |
| function AnySiteID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ServerSites.SiteID |
| Description: |
|
|
|
| BaseTemplateID |
| function BaseTemplateID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| COLLECTIONNAME_EXISTING |
| function CollectionName_Existing |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'CollectionName_Existing' |
| Description: |
|
|
|
| COLLECTIONNAME_EXISTINGLIST |
| function CollectionName_ExistingList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'CollectionName_ExistingList' |
| Description: |
|
|
|
| COLLECTIONNAME_NONEXISTING |
| function CollectionName_NonExisting |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'CollectionName_NonExisting' |
| Description: |
|
|
|
| CONTRIBUTORID |
| function ContributorID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'ContributorID' |
| Description: |
|
|
|
| ConfidentialityID |
| function ConfidentialityID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in GeneralCategories.ID |
| Description: |
|
|
|
| ContactID |
| function ContactID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Contacts.ContactID |
| Description: |
|
|
|
| ContactTypeID |
| function ContactTypeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ContactType.ID |
| Description: |
|
|
|
| ContainerElementInstanceID |
| function ContainerElementInstanceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ControlInstance.ControlID |
| Description: |
|
|
|
| ContributorIDGroupID |
| function ContributorIDGroupID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
alias for 'ContributorID' |
| Description: |
|
|
|
| ContributorUserID |
| function ContributorUserID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
alias for 'ContributorID' |
| Description: |
|
|
|
| CurrentCustomerID |
| function CurrentCustomerID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in HostingCustomers.ID |
| Description: |
|
|
|
| CurrentCustomerSiteID |
| function CurrentCustomerSiteID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ServerSites.SiteID |
| Description: |
|
|
|
| CustomElementID |
| function CustomElementID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in AvailableControls.ID |
| Description: |
|
|
|
| CustomFieldTypeID |
| function CustomFieldTypeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in CustomFieldTypes.ID |
| Description: |
|
|
|
| CustomerScheduledJobID |
| function CustomerScheduledJobID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Customer_SchedJobs.ID |
| Description: |
|
|
|
| DashboardSectionID |
| function DashboardSectionID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in DashboardSections.ID |
| Description: |
|
|
|
| DashboardSectionID_Custom |
| function DashboardSectionID_Custom |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in DashboardSections.ID |
| Description: |
|
|
|
| DashboardSectionID_Standard |
| function DashboardSectionID_Standard |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in DashboardSections.ID |
| Description: |
|
|
|
| DatasheetElementInstanceID |
| function DatasheetElementInstanceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ControlInstance.ControlID |
| Description: |
|
|
|
| DocumentCategoryID |
| function DocumentCategoryID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in DocCategories.ID |
| Description: |
|
|
|
| ElementFoundationID |
| function ElementFoundationID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ElementClasses.ElementClassID |
| Description: |
|
|
|
| ElementID |
| function ElementID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in AvailableControls.ID |
| Description: |
|
|
|
| FACTORYORSAVEDELEMENTTYPEID |
| function FactoryOrSavedElementTypeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'FactoryOrSavedElementTypeID' |
| Description: |
|
|
|
| FeedCategoryID |
| function FeedCategoryID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in XMLPublicationCategories.ID |
| Description: |
|
|
|
| FieldID |
| function FieldID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in FormInputControlMap.FieldID |
| Description: |
|
|
|
| FieldTypeID |
| function FieldTypeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SystemVariableTypes.ID |
| Description: |
|
|
|
| FileFormat |
| function FileFormat |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Formats.Extension |
| Description: |
|
|
|
| FileFormatID |
| function FileFormatID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Formats.ID |
| Description: |
|
|
|
| FileFormatList |
| function FileFormatList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in Formats.Extension |
| Description: |
|
|
|
| FontID |
| function FontID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Fonts.ID |
| Description: |
|
|
|
| GlobalCustomElementID |
| function GlobalCustomElementID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in AvailableControls.ID |
| Description: |
|
|
|
| GroupID |
| function GroupID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in idGroup.ID |
| Description: |
|
|
|
| GroupIDList |
| function GroupIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in idGroup.ID |
| Description: |
|
|
|
| IMAGEFILENAME |
| function ImageFileName |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'ImageFileName' |
| Description: |
|
|
|
| ImageCategoryID |
| function ImageCategoryID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ImageCategories.ID |
| Description: |
|
|
|
| ImageID |
| function ImageID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| KEYWORD_EXISTING |
| function Keyword_Existing |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Additional validation for 'Keyword_Existing' |
| Description: |
|
|
|
| KEYWORD_NONEXISTING |
| function Keyword_NonExisting |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'Keyword_NonExisting' |
| Description: |
|
|
|
| KeywordableObjectID |
| function KeywordableObjectID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| LOCALEDATEFORMAT |
| function LocaleDateFormat |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'LocaleDateFormat' |
| Description: |
|
|
|
| LOCALETIMEFORMAT |
| function LocaleTimeFormat |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'LocaleTimeFormat' |
| Description: |
|
|
|
| MEMBERIDGROUPIDPAIR |
| function MemberIDGroupIDPair |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
validates that the value is a valid memberID:GroupID, where memberID is a USerID or GroupID |
| Description: |
|
|
|
| MetadataFormID |
| function MetadataFormID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in FormControl.ID |
| Description: |
|
|
|
| MetadataFormName_Existing |
| function MetadataFormName_Existing |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in FormControl.FormName |
| Description: |
|
|
|
| MultiSectionElementInstanceID |
| function MultiSectionElementInstanceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ControlInstance.ControlID |
| Description: |
|
|
|
| NoteID |
| function NoteID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Data_Annotation.NoteID |
| Description: |
|
|
|
| NoteIDList |
| function NoteIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in Data_Annotation.NoteID |
| Description: |
|
|
|
| OWNERID |
| function OwnerID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
validates that the value for ownerID is a valid userID or groupID |
| Description: |
|
|
|
| OutputTypeID |
| function OutputTypeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in OutputTypes.OutputTypeID |
| Description: |
|
|
|
| PageID |
| function PageID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| PageIDImageID |
| function PageIDImageID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| PageIDImageIDList |
| function PageIDImageIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in SitePages.ID |
| Description: |
|
|
|
| PageIDList |
| function PageIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in SitePages.ID |
| Description: |
|
|
|
| PageID_NonBaseTemplate |
| function PageID_NonBaseTemplate |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| PageSetID |
| function PageSetID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| PaneID |
| function PaneID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Panes.ID |
| Description: |
|
|
|
| PanelID |
| function PanelID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Panes.ID |
| Description: |
|
|
|
| PublicationDefinitionID |
| function PublicationDefinitionID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ID.Action='xmlpub' |
| Description: |
|
|
|
| QBEElementInstanceID |
| function QBEElementInstanceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ControlInstance.ControlID |
| Description: |
|
|
|
| RealPageID |
| function RealPageID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageIDList |
| function RealPageIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in SitePages.ID |
| Description: |
|
|
|
| RealPageID_AnyTemplate |
| function RealPageID_AnyTemplate |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageID_NonBaseTemplate |
| function RealPageID_NonBaseTemplate |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageID_NonTemplate |
| function RealPageID_NonTemplate |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageID_NonTemplate_List |
| function RealPageID_NonTemplate_List |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in SitePages.ID |
| Description: |
|
|
|
| RealPageID_PageSetID |
| function RealPageID_PageSetID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageID_UploadedDocID |
| function RealPageID_UploadedDocID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageID_UploadedDocID_NonBaseTemplate |
| function RealPageID_UploadedDocID_NonBaseTemplate |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageID_UploadedDocID_RegisteredURLID |
| function RealPageID_UploadedDocID_RegisteredURLID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RealPageID_UploadedDocID_RegisteredURLID_List |
| function RealPageID_UploadedDocID_RegisteredURLID_List |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in SitePages.ID |
| Description: |
|
|
|
| RegisteredClassID |
| function RegisteredClassID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in RegisteredClassNames.StringID |
| Description: |
|
|
|
| RegisteredURLID |
| function RegisteredURLID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| RegisteredURLIDList |
| function RegisteredURLIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in SitePages.ID |
| Description: |
|
|
|
| ReminderID |
| function ReminderID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Reminders.ReminderID |
| Description: |
|
|
|
| RenderHandlerID |
| function RenderHandlerID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in CustomElementModules.ID |
| Description: |
|
|
|
| ReplicationID |
| function ReplicationID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SiteSync.GroupID |
| Description: |
|
|
|
| ReplicationScopeID |
| function ReplicationScopeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ReplicationScopes.ScopeID |
| Description: |
|
|
|
| SIMPLEFORMID |
| function SimpleFormID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Validation for SimpleForID |
| Description: |
|
|
|
| SUBSITEIDORURL |
| function SubsiteIDorURL |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
additional validation for 'SubsiteIDorURL' |
| Description: |
|
|
|
| SavedSearchID |
| function SavedSearchID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SavedSearches.ID |
| Description: |
|
|
|
| ScheduleElementInstanceID |
| function ScheduleElementInstanceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ControlInstance.ControlID |
| Description: |
|
|
|
| SeeAlsoID |
| function SeeAlsoID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Data_SeeAlso.ID |
| Description: |
|
|
|
| ServerID |
| function ServerID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Servers.ID |
| Description: |
|
|
|
| ServerScheduledJobID |
| function ServerScheduledJobID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Server_SchedJobs.ID |
| Description: |
|
|
|
| ShortcutID |
| function ShortcutID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Shortcuts.ShortcutID |
| Description: |
|
|
|
| SimpleFormID_Standard |
| function SimpleFormID_Standard |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in FormControl.ID |
| Description: |
|
|
|
| SiteScheduledJobID |
| function SiteScheduledJobID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Site_SchedJobs.ID |
| Description: |
|
|
|
| StyleSheetID |
| function StyleSheetID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Data_Stylesheets.ItemID |
| Description: |
|
|
|
| StyleSheetSetID |
| function StyleSheetSetID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Data_StyleSheetGroups.ItemID |
| Description: |
|
|
|
| TAG_EXISTING |
| function Tag_Existing |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Additional validation for 'Tag_Existing' |
| Description: |
|
|
|
| TabularLayoutInstanceID |
| function TabularLayoutInstanceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in ControlInstance.ControlID |
| Description: |
|
|
|
| TaxonomyID |
| function TaxonomyID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Taxonomy.ID |
| Description: |
|
|
|
| TemplateCategoryID |
| function TemplateCategoryID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in TemplateCategoryLookup.ID |
| Description: |
|
|
|
| TemplateID |
| function TemplateID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in AvailableTemplates.PageID |
| Description: |
|
|
|
| TemplateIDList |
| function TemplateIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in AvailableTemplates.PageID |
| Description: |
|
|
|
| TransactionTypeID |
| function TransactionTypeID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in TransactionType.ID |
| Description: |
|
|
|
| UPLOADEDDOCUMENTFILENAME |
| function UploadedDocumentFileName |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'UploadedDocumentFileName' |
| Description: |
|
|
|
| USERGROUPID |
| function UserGroupID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
validates that the value is a valid userID or groupID |
| Description: |
|
|
|
| USERIDGROUPIDPAIR |
| function UserIDGroupIDPair |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
validates that the value is a valid userID:GroupID |
| Description: |
|
|
|
| UploadedDocumentID |
| function UploadedDocumentID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| UserGroupID_ExcludingAnon |
| function UserGroupID_ExcludingAnon |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
alias for 'UserGroupID' |
| Description: |
|
|
|
| UserGroupID_ExcludingAnonAuth |
| function UserGroupID_ExcludingAnonAuth |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
alias for 'UserGroupID' |
| Description: |
|
|
|
| UserGroupID_ExcludingAnonAuthContrib |
| function UserGroupID_ExcludingAnonAuthContrib |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
alias for 'UserGroupID' |
| Description: |
|
|
|
| UserID |
| function UserID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in Users.ID |
| Description: |
|
|
|
| UserIDList |
| function UserIDList |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies that all members of the input list exist in Users.ID |
| Description: |
|
|
|
| UserIDorAnonymous |
| function UserIDorAnonymous |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
alias for 'UserID' |
| Description: |
|
|
|
| WorkRequestID |
| function WorkRequestID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in WorkRequest.ID |
| Description: |
|
|
|
| WorkRequestResourceID |
| function WorkRequestResourceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in WorkTypeCategories.ID |
| Description: |
|
|
|
| WorkRequestResourceIDActive |
| function WorkRequestResourceIDActive |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in WorkTypeCategories.ID |
| Description: |
|
|
|
| XMLPublicationBindingID |
| function XMLPublicationBindingID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in XPItemFieldBinding.BindingID |
| Description: |
|
|
|
| XMLPublicationDefinitionID |
| function XMLPublicationDefinitionID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in FormControl.ID |
| Description: |
|
|
|
| XMLPublicationFormatID |
| function XMLPublicationFormatID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in XMLPublicationFormat.XMLPublicationFormatID |
| Description: |
|
|
|
| XMLPublicationInstanceID |
| function XMLPublicationInstanceID |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Verifies the input value exists in SitePages.ID |
| Description: |
|
|
|
| XMLTEXT |
| function XMLText |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Additional validation for 'XMLText' |
| Description: |
|
|
|
|
|
| admin |
| struct |
| USEDASHBOARDUI |
| function UseDashboardUI |
| Arguments: | none |
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns 1 if the dashboard UI and associated look-and-feel changes should be used |
| Description: |
|
|
|
|
| adminmenucustomizations |
| struct |
| LOAD |
| function load |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a structure with two members to two queries |
| Description: |
|
|
|
|
| advancedsearch |
| struct |
| BUILDDEFAULTCOMMONFILTER |
| function buildDefaultCommonFilter |
Arguments:
| Name |
Required |
Type |
Default |
| params |
Required |
Struct |
|
| filterType |
Required |
numeric |
|
| forceCache |
Required |
numeric |
|
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMCRITERIAARRAY |
| function getCustomCriteriaArray |
Arguments:
| Name |
Required |
Type |
Default |
| params |
Required |
Struct |
|
| forceCache |
Optional |
boolean |
false |
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| approve |
| struct |
| GETPENDINGAPPROVALS |
| function getPendingApprovals |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
| ControlID |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| cluster |
| struct |
| GETSLAVEPATH |
| function getSlavePath |
Arguments:
| Name |
Required |
Type |
Default |
| MasterPath |
Required |
string |
|
| SlaveID |
Required |
numeric |
|
| IgnoreMissingMapping |
Optional |
boolean |
no |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces get-slave-path.cfm - given a path, returns equivalent for cluster ROPS |
| Description: |
|
|
|
| REMOVEDISPLAYTEMPLATECACHE |
| function removeDisplayTemplateCache |
Arguments:
| Name |
Required |
Type |
Default |
| ControlID |
Optional |
numeric |
0 |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
remove temp-xxx-xxx.element cache files |
| Description: |
|
|
|
| UPDATECUSTOMELEMENTCACHE |
| function updateCustomElementCache |
Arguments:
| Name |
Required |
Type |
Default |
| targetFormID |
Required |
numeric |
0 |
| targetPageID |
Required |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
calls handle-cache.cfm for given FormID/PageID |
| Description: |
|
|
|
| UPDATESERVERCACHE |
| function updateServerCache |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
calls force-cluster-init |
| Description: |
|
|
|
|
| comparetools |
| struct |
| ISEQUAL |
| function IsEqual |
Arguments:
| Name |
Required |
Type |
Default |
| item1 |
Required |
any |
|
| item2 |
Required |
any |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns true if the two given objects are identical |
| Description: |
|
|
|
| LISTCOMPARE |
| function ListCompare |
Arguments:
| Name |
Required |
Type |
Default |
| list1 |
Required |
string |
|
| list2 |
Required |
string |
|
| caseSensitive |
Optional |
boolean |
true |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
build a structure with comparison results for two lists |
| Description: |
|
|
|
| STRUCTCOMPARE |
| function StructCompare |
Arguments:
| Name |
Required |
Type |
Default |
| struct1 |
Required |
struct |
|
| struct2 |
Required |
struct |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
build a structure with comparison results for two structures |
| Description: |
|
|
|
|
| css |
| struct |
| CONVERTFONTSIZE |
| function ConvertFontSize |
Arguments:
| Name |
Required |
Type |
Default |
| FontSize |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLASSNAMES |
| function GetClassNames |
Arguments:
| Name |
Required |
Type |
Default |
| classIDs |
Optional |
Any |
|
| checkElementStyles |
Optional |
Any |
|
| controlID |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETSTYLEDEF |
| function setStyleDef |
Arguments:
| Name |
Required |
Type |
Default |
| styleName |
Required |
string |
|
| fontFace |
Required |
string |
|
| fontSize |
Required |
numeric |
|
| color |
Required |
string |
|
| bold |
Required |
boolean |
|
| italic |
Required |
boolean |
|
| linkType |
Optional |
numeric |
0 |
| useLinkColor |
Optional |
boolean |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
adds/updates a style definition in Request.RenderState.InlineStyles. Returns CSS generated from the given parameters |
| Description: |
|
|
|
|
| custom_element |
| struct |
| CLEARCACHE |
| function clearCache |
Arguments:
| Name |
Required |
Type |
Default |
| elementTypeID |
Required |
numeric |
|
| dataList |
Optional |
string |
[empty string] |
| DSN |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces controls/custom/tags/del-cache.cfm |
| Description: |
|
|
|
| GETCACHE |
| function getCache |
Arguments:
| Name |
Required |
Type |
Default |
| elementTypeID |
Required |
numeric |
|
| dataList |
Required |
string |
|
|
| ReturnType: |
array
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces controls/custom/tags/get-cache.cfm |
| Description: |
|
|
|
| INVALIDATECACHEBYFIELDID |
| function invalidateCacheByFieldID |
Arguments:
| Name |
Required |
Type |
Default |
| fieldID |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INVALIDATECUSTOMELEMENTCACHEBYFIELDID |
| function invalidateCustomElementCacheByFieldID |
Arguments:
| Name |
Required |
Type |
Default |
| fieldIDList |
Required |
string |
|
| DSN |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces controls/custom/tags/del-cache.cfm |
| Description: |
|
|
|
|
| customelementfield |
| struct |
| ESC |
| function esc |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
| fieldType |
Required |
string |
|
| mode |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCBUILTINEDIT |
| function escBuiltinEdit |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCBUILTINRENDER |
| function escBuiltinRender |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCHTMLEDIT |
| function escHTMLEdit |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCHTMLPLUSEDIT |
| function escHTMLPlusEdit |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCHTMLPLUSRENDER |
| function escHTMLPlusRender |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCHTMLRENDER |
| function escHTMLRender |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCIMGEDIT |
| function escImgEdit |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCIMGRENDER |
| function escImgRender |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCQUERY |
| function escQuery |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
query |
|
| fields |
Required |
struct |
|
| mode |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCSTRUCT |
| function escStruct |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
struct |
|
| fields |
Required |
struct |
|
| mode |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCTEXTEDIT |
| function escTextEdit |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCTEXTRENDER |
| function escTextRender |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCUNPROCESSEDEDIT |
| function escUnprocessedEdit |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCUNPROCESSEDRENDER |
| function escUnprocessedRender |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETESCAPEMODE |
| function getEscapeMode |
Arguments:
| Name |
Required |
Type |
Default |
| typeName |
Required |
string |
|
| customFieldTypeDatatype |
Required |
string |
|
| context |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETESCAPEMODEBYID |
| function getEscapeModeByID |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
| fieldID |
Required |
numeric |
|
| context |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PREPFORSAVE |
| function prepForSave |
Arguments:
| Name |
Required |
Type |
Default |
| fieldData |
Required |
string |
|
| inputType |
Required |
string |
|
| CFTID |
Required |
string |
|
| RTE |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| data |
| struct |
| BREAKINHERITANCE |
| function breakInheritance |
Arguments:
| Name |
Required |
Type |
Default |
| tableName |
Required |
string |
|
| targetPageID |
Required |
numeric |
|
| controlID |
Required |
numeric |
|
| inheritanceList |
Required |
string |
|
| targetVersionState |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CONSTRUCTUSERFULLNAMESTRING |
| function constructUserFullNameString |
Arguments:
| Name |
Required |
Type |
Default |
| first |
Required |
string |
|
| middle |
Required |
string |
|
| last |
Required |
string |
|
| format |
Optional |
numeric |
1 |
| lengthlimit |
Optional |
numeric |
-1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
appends firstname, lastname and middlename of a commonspot user in the given format. |
| Description: |
|
|
|
| CONTAINSINARRAY |
| function ContainsInArray |
Arguments:
| Name |
Required |
Type |
Default |
| array |
Optional |
Any |
|
| value |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CONVERTCUSTOMELEMENTURLONROPS |
| function ConvertCustomElementURLOnROPS |
Arguments:
| Name |
Required |
Type |
Default |
| urlString |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CONVERTSITEURLONCLUSTERROPS |
| function ConvertSiteURLOnClusterROPS |
Arguments:
| Name |
Required |
Type |
Default |
| urlString |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEGUID |
| function CSCreateGUID |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEMULTIPLE |
| function deleteMultiple |
Arguments:
| Name |
Required |
Type |
Default |
| idList |
Required |
string |
|
| deleteMethod |
Required |
string |
|
| idArgumentName |
Optional |
string |
ID |
| moreArgs |
Optional |
struct |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Calls the requested delete method for each passed ID, returns a structure with success, and an entry for each ErrorCode caught, with the count of failures of that type. |
| Description: |
|
|
|
| FINDINARRAY |
| function FindInArray |
Arguments:
| Name |
Required |
Type |
Default |
| array |
Optional |
Any |
|
| valueToFind |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FROMHTML |
| function CSFromHTML |
Arguments:
| Name |
Required |
Type |
Default |
| source |
Required |
string |
|
| translateBR |
Optional |
numeric |
1 |
| translateMultiNBSP |
Optional |
numeric |
1 |
| translateAMP |
Optional |
numeric |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
un-winds one layer of CommonSpot-style HTML escaping |
| Description: |
|
|
|
| GETALLINUSETAXONOMYID |
| function GetAllInUseTaxonomyID |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns all in use Taxonomy ID |
| Description: |
|
|
|
| GETCACHEORNULL |
| function getCacheOrNULL |
Arguments:
| Name |
Required |
Type |
Default |
| cacheObj |
Required |
any |
|
| key |
Required |
String |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPATCHSIG |
| function GetPatchSig |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPERMSORNULL |
| function getPermsOrNULL |
Arguments:
| Name |
Required |
Type |
Default |
| sicObj |
Required |
any |
|
| cID |
Required |
numeric |
|
| uObj |
Required |
any |
|
| newIfNULL |
Optional |
boolean |
false |
| cloneIt |
Optional |
boolean |
false |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSELECTEDOPTIONINDEXES |
| function getSelectedOptionIndexes |
Arguments:
| Name |
Required |
Type |
Default |
| optionsArray |
Optional |
Any |
|
| selValuesList |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSUBQUERYFACETNAV |
| function GetSubQueryFacetNav |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Optional |
Any |
|
| BoundToFacetNavControl |
Optional |
Any |
|
| columnString |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETUSERCONTACTINFO |
| function getUserContactInfo |
Arguments:
| Name |
Required |
Type |
Default |
| userID |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETUSERCONTACTINFOTEXT |
| function getUserContactInfoText |
Arguments:
| Name |
Required |
Type |
Default |
| info |
Required |
struct |
|
| label |
Required |
string |
|
| asHTML |
Required |
boolean |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MULTISORT |
| function MultiSort |
Arguments:
| Name |
Required |
Type |
Default |
| array |
Optional |
Any |
|
| dimension |
Optional |
Any |
|
| sortOrder |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PARSEHTMLTAG |
| function parseHTMLTag |
Arguments:
| Name |
Required |
Type |
Default |
| htmlString |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Parses the given HTML tag into a ColdFusion struct. |
| Description: |
|
|
|
| PREPFORCTRECORDCHANGE |
| function prepForCTRecordChange |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REPLACEALLTOONE |
| function ReplaceAllToOne |
Arguments:
| Name |
Required |
Type |
Default |
| inputString |
Optional |
Any |
|
| inputChar |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETFACETNAVOBJECT |
| function SetFacetNavObject |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Optional |
Any |
|
| BoundToFacetNavControl |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SORTEDARRAYCONTAINS |
| function SortedArrayContains |
Arguments:
| Name |
Required |
Type |
Default |
| array |
Optional |
Any |
|
| value |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SORTEDARRAYFIND |
| function SortedArrayFind |
Arguments:
| Name |
Required |
Type |
Default |
| array |
Optional |
Any |
|
| value |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| TOHTML |
| function CSToHTML |
Arguments:
| Name |
Required |
Type |
Default |
| source |
Required |
string |
|
| translateNewlines |
Optional |
numeric |
1 |
| escapePipes |
Optional |
numeric |
1 |
| translateMultiSpace |
Optional |
numeric |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
does one layer of CommonSpot-style HTML escaping |
| Description: |
|
|
|
| WIN1252_TO_ENTITIES |
| function Win1252_to_Entities |
Arguments:
| Name |
Required |
Type |
Default |
| badString |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| database |
| struct |
| ADDLINKSTATUSTYPETOQUERY |
| function addLinkStatusTypeToQuery |
Arguments:
| Name |
Required |
Type |
Default |
| linksqry |
Required |
query |
|
| linkStatusCol |
Required |
string |
|
| linkIsInternalCol |
Required |
string |
|
| linkIsInCSCol |
Required |
string |
|
| linkTypeCol |
Optional |
string |
[empty string] |
| linkSubSiteURLCol |
Optional |
string |
[empty string] |
| linkFileNameCol |
Optional |
string |
[empty string] |
| linkURLCol |
Optional |
string |
[empty string] |
| linkPageTypeCol |
Optional |
string |
[empty string] |
| qryURLCol |
Optional |
string |
[empty string] |
| qryMessageCol |
Optional |
string |
[empty string] |
| qryStatusTypeCol |
Optional |
string |
[empty string] |
| finalColumns |
Optional |
string |
[empty string] |
|
| ReturnType: |
Query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Update the linkStatus type to the Query |
| Description: |
|
|
|
| ADDPAGEURLTOQUERY |
| function addPageURLToQuery |
Arguments:
| Name |
Required |
Type |
Default |
| pageqry |
Required |
query |
|
| pageIDCol |
Required |
string |
|
| subsiteURLCol |
Required |
string |
|
| pageTypeCol |
Required |
string |
|
| filenameCol |
Required |
string |
|
| isUploadedDocColValue |
Required |
string |
|
| pageURLCol |
Required |
string |
|
| finalColumns |
Optional |
string |
[empty string] |
| pageNameCol |
Optional |
string |
[empty string] |
|
| ReturnType: |
Query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
update the page URL |
| Description: |
|
|
|
| BUILDLARGEINCLAUSE |
| function BuildLargeInClause |
Arguments:
| Name |
Required |
Type |
Default |
| inList |
Required |
string |
|
| compareVar |
Required |
String |
|
| isUniqueList |
Optional |
boolean |
false |
| isNumeric |
Optional |
boolean |
true |
| isNot |
Optional |
boolean |
false |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| BUILDPAGEURL |
| function buildPageURL |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| isUploadedDoc |
Required |
boolean |
|
| pageType |
Required |
numeric |
|
| filename |
Required |
string |
|
| subsiteURL |
Required |
string |
|
| name |
Optional |
string |
[empty string] |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
updates the page URL |
| Description: |
|
|
|
| CALCMAXROWS |
| function calcMaxRows |
Arguments:
| Name |
Required |
Type |
Default |
| limit |
Required |
numeric |
|
| scalabilityMax |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Takes passed limit and scalabilityMax, returns the effective maxRows to use. At this time: Less than zero = Use scalabilityMax + 1, zero = Use zero (all rows), else = Use passed limit + 1. The standard default value for limit arguments should be the constant LIMIT_TO_SCALABILITY_MAX between pound signs (defined in base-component.cfc), which is less than zero. |
| Description: |
|
|
|
| CHECKDBVERSION |
| function checkDbVersion |
Arguments:
| Name |
Required |
Type |
Default |
| dsn |
Required |
string |
|
| minVersion |
Required |
String |
|
| maxVersion |
Required |
String |
|
| deleteDSonError |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDATABASETYPE |
| function getDatabaseType |
Arguments:
| Name |
Required |
Type |
Default |
| datasourceName |
Required |
string |
|
| datasourceType |
Optional |
string |
site |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDATASOURCECONNECTION |
| function GetDataSourceConnection |
Arguments:
| Name |
Required |
Type |
Default |
| dsname |
Required |
string |
|
| useJavaConn |
Optional |
boolean |
yes |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDFVLISTTYPE |
| function GetDFVListType |
Arguments:
| Name |
Required |
Type |
Default |
| dsn |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMAXROWSSQL |
| function GetMaxRowsSql |
Arguments:
| Name |
Required |
Type |
Default |
| dbType |
Required |
string |
|
| reports_max |
Required |
string |
|
| complexType |
Optional |
boolean |
no |
| orderByForUnion |
Optional |
string |
[empty string] |
| distinct |
Optional |
boolean |
false |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct with SQL fragments to append before and after a query to return a spec'd number of rows max. |
| Description: |
|
|
|
| GETPADDEDVERSION |
| function GetPaddedVersion |
Arguments:
| Name |
Required |
Type |
Default |
| dbversion |
Required |
string |
|
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTAXONOMYDATABYTERMIDS |
| function GetTaxonomyDataByTermIds |
Arguments:
| Name |
Required |
Type |
Default |
| taxonomyID |
Required |
numeric |
|
| termIDs |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
get the names of facet and terms by given termIDs |
| Description: |
|
|
|
| GETUDF |
| function getUDF |
Arguments:
| Name |
Required |
Type |
Default |
| dsn |
Required |
string |
|
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns udf by dbtype |
| Description: |
|
|
|
| KILLMYSQLSLEEPCONNECTIONS |
| function killMySQLSleepConnections |
Arguments:
| Name |
Required |
Type |
Default |
| dsn |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LIMITQUERY |
| function limitQuery |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
query |
|
| limit |
Required |
numeric |
|
| queryType |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Takes a passed query and a limit argument, returns a validated struct with two elements: resultQuery is the passed query, limited to the passed number of rows, and limitExceeded is a boolean indicating whether more rows were present in the query than allowed. If limit is 0, query is returned unchanged and limitExceeded will be false. The result is typed as the passed queryType. |
| Description: |
|
|
|
| ORACLEVARCHARISUTF8 |
| function oracleVarcharIsUTF8 |
Arguments:
| Name |
Required |
Type |
Default |
| DSN |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns true if Oracle datasource supports UTF8 in VARCHAR2/CLOB fields |
| Description: |
|
|
|
| PRESERVESEQQOFQ |
| function PreserveSeqQofQ |
Arguments:
| Name |
Required |
Type |
Default |
| origList |
Required |
string |
|
| newList |
Required |
string |
|
|
| ReturnType: |
Query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETREPLICATIONDIRRECORD |
| function SetReplicationDirRecord |
Arguments:
| Name |
Required |
Type |
Default |
| savedDirName |
Required |
string |
|
| defaultDirName |
Required |
string |
|
| dirType |
Required |
numeric |
|
| dirFreq |
Required |
numeric |
|
| dirCache |
Optional |
numeric |
|
| recurse |
Required |
numeric |
|
| insertionTimestamp |
Required |
string |
|
| dsn |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
insert record in ReplicationDirectories table when create a new site |
| Description: |
|
|
|
| SETTAXONOMYRELATIONSHIPTYPERECORD |
| function SetTaxonomyRelationshipTypeRecord |
Arguments:
| Name |
Required |
Type |
Default |
| taxonomyid |
Required |
numeric |
|
| relationshiptype |
Required |
string |
|
| typeDescription |
Required |
string |
|
| checkBeforeInsert |
Optional |
boolean |
yes |
| setType |
Optional |
string |
insert |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
insert/update record in TaxonomyRelationshipType table |
| Description: |
|
|
|
| SORTQUERY |
| function sortQuery |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
Any |
|
| sortCol |
Required |
Any |
|
| sortDir |
Optional |
Any |
ASC |
| limit |
Optional |
Any |
[runtime expression] |
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Sorts passed query by requested (single) sortCol. |
| Description: |
|
|
|
| TAXONOMYNAMEEXISTS |
| function TaxonomyNameExists |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEDATASOURCECACHE |
| function updateDatasourceCache |
Arguments:
| Name |
Required |
Type |
Default |
| DSN |
Required |
string |
|
| action |
Required |
string |
|
| dsType |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
updates the datasource cache |
| Description: |
|
|
|
| VERIFYMYSQLDSN |
| function VerifyMySQLDSN |
Arguments:
| Name |
Required |
Type |
Default |
| MySQLDS |
Required |
string |
|
| deleteDSonError |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| VERIFYORACLEDSN |
| function VerifyOracleDSN |
Arguments:
| Name |
Required |
Type |
Default |
| OracleDS |
Required |
string |
|
| deleteDSonError |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| VERIFYPOSTGRESQLDSN |
| function VerifyPostgreSQLDSN |
Arguments:
| Name |
Required |
Type |
Default |
| PostgreSQLDS |
Required |
string |
|
| deleteDSonError |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| VERIFYSQLSERVERDSN |
| function VerifySQLServerDSN |
Arguments:
| Name |
Required |
Type |
Default |
| SQLServerDS |
Required |
string |
|
| deleteDSonError |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| debug |
| struct |
| CHECKDEBUGSTRUCT |
| function checkDebugStruct |
Arguments:
| Name |
Required |
Type |
Default |
| actual |
Required |
string |
|
| structKeyName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns the updated permission list set through debug settings |
| Description: |
|
|
|
| DUMPLRUCACHE |
| function dumpLRUCache |
Arguments:
| Name |
Required |
Type |
Default |
| cacheObject |
Required |
any |
|
| Label |
Required |
string |
|
| getKeysList |
Optional |
boolean |
no |
| getCachedObjects |
Optional |
boolean |
no |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
yes |
| DisplayName: |
|
| Hint: |
Outputs an HTML dump of an LRUCache, including usage stats and optionally a list of the keys of all cached objects and a dump of the objects themselves. |
| Description: |
|
|
|
| GETLRUCACHESTATS |
| function getLRUCacheStats |
Arguments:
| Name |
Required |
Type |
Default |
| cacheObject |
Required |
any |
|
| getKeysList |
Optional |
boolean |
no |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct with various usage stats for the requested LRU cache. |
| Description: |
|
|
|
|
| element |
| struct |
| CALLELEMENT |
| function CallElement |
Arguments:
| Name |
Required |
Type |
Default |
| cachePageID |
Required |
numeric |
|
| cacheSubsiteID |
Required |
numeric |
|
| cacheParentID |
Required |
numeric |
|
| controlName |
Required |
string |
|
| isWIP |
Required |
boolean |
|
| wantStatusUpdate |
Optional |
boolean |
yes |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a CacheResults object |
| Description: |
|
|
|
| CALLFIELDRENDERMODULE |
| function CallFieldRenderModule |
Arguments:
| Name |
Required |
Type |
Default |
| RenderModule |
Required |
string |
|
| args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
calls render handler for a field embedded in an RTE block |
| Description: |
|
|
|
| CHECKEPARAM |
| function CheckeParam |
Arguments:
| Name |
Required |
Type |
Default |
| prop |
Required |
Struct |
|
| field |
Required |
String |
|
| allowEmptyStr |
Optional |
Boolean |
yes |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DEFERRENDERING |
| function DeferRendering |
Arguments:
| Name |
Required |
Type |
Default |
| ControlID |
Required |
numeric |
|
| ControlTypeID |
Required |
numeric |
|
| ForceLast |
Optional |
numeric |
0 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
call to punt element rendering to a second rendering pass |
| Description: |
|
|
|
| DELETECACHEFILES |
| function DeleteCacheFiles |
Arguments:
| Name |
Required |
Type |
Default |
| FilenameRoot |
Required |
string |
|
| IsWIP |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCACHEPATH |
| function GetCachePath |
Arguments:
| Name |
Required |
Type |
Default |
| SubsiteID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
| ControlID |
Required |
numeric |
|
| ControlTypeID |
Required |
numeric |
|
| CacheLevel |
Required |
numeric |
|
| DeviceDependency |
Required |
numeric |
|
| Device |
Required |
String |
|
| IsWIP |
Required |
boolean |
|
| OutputType |
Required |
string |
|
| OutputFormat |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a CacheResults object |
| Description: |
|
|
|
| GETCACHEPATHROOT |
| function GetCachePathRoot |
Arguments:
| Name |
Required |
Type |
Default |
| SubsiteID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
| ControlID |
Required |
numeric |
|
| ControlTypeID |
Required |
numeric |
|
| CacheLevel |
Required |
numeric |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a CacheResults object |
| Description: |
|
|
|
| GETELEMENTPROPS |
| function getElementProps |
Arguments:
| Name |
Required |
Type |
Default |
| ControlID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
| InheritanceList |
Optional |
string |
(need query) |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns ControlName, ControlType, ParentControlID, and ParentControlType for given PageID/ControlID |
| Description: |
|
|
|
| HANDLECACHEFLAGS |
| function HandleCacheFlags |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
equivalent to 'old' handle-cache-flags |
| Description: |
|
|
|
| HANDLEELEMENTOUTPUT |
| function HandleElementOutput |
Arguments:
| Name |
Required |
Type |
Default |
| generatedOutput |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| HANDLENODATA |
| function handleNoData |
Arguments:
| Name |
Required |
Type |
Default |
| ControlID |
Required |
numeric |
|
| ControlTypeID |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
yes |
| DisplayName: |
|
| Hint: |
Outputs result of a custom no data (ghost text) handler module. |
| Description: |
|
|
|
| INSERTCONTROLINCONTAINERELEMENT |
| function InsertControlInContainerElement |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| elementTypeID |
Required |
numeric |
|
| parentControlID |
Required |
numeric |
|
| customTag |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCONTROLINMULTISECTIONELEMENT |
| function InsertControlInMultiSectionElement |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| elementTypeID |
Required |
numeric |
|
| containerID |
Required |
numeric |
|
| parentControlID |
Required |
numeric |
|
| customTag |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCONTROLINSCHEDULEELEMENT |
| function InsertControlInScheduleElement |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| elementTypeID |
Required |
numeric |
|
| parentType |
Required |
string |
|
| parentControlID |
Required |
numeric |
|
| name |
Required |
string |
|
| customTag |
Optional |
string |
[empty string] |
| position |
Optional |
string |
end |
| itemPos |
Optional |
numeric |
0 |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCONTROLINTABULARLAYOUTELEMENT |
| function InsertControlInTabularLayoutElement |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| elementTypeID |
Required |
numeric |
|
| containerID |
Required |
numeric |
|
| parentControlID |
Required |
numeric |
|
| customTag |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INVOKECUSTOMHOOK |
| function invokeCustomHook |
Arguments:
| Name |
Required |
Type |
Default |
| customHookType |
Required |
string |
|
| valuesStruct |
Required |
struct |
|
| customHookArgsArray |
Required |
array |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
invokes custom hook from the location given. |
| Description: |
|
|
|
| ISWIP |
| function isWIP |
Arguments:
| Name |
Required |
Type |
Default |
| ControlID |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PREPAREDEBUGOUTPUT |
| function PrepareDebugOutput |
Arguments:
| Name |
Required |
Type |
Default |
| ControlID |
Required |
numeric |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PREPAREELEMENTFORCACHE |
| function PrepareElementForCache |
Arguments:
| Name |
Required |
Type |
Default |
| generatedOutput |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PREPAREFORMATTEDTEXTBLOCK |
| function PrepareFormattedTextblock |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
| ControlID |
Required |
numeric |
|
| TextBlock |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
prepares a formatted textblock for output |
| Description: |
|
|
|
| PREPROCESSCPMODULEARGUMENT |
| function PreprocessCPModuleArgument |
Arguments:
| Name |
Required |
Type |
Default |
| attr |
Required |
string |
|
| escapeMode |
Optional |
string |
[empty string] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REPLACEDYNAMICSTATUSWITHHUMANREADABLEDESCQUERY |
| function ReplaceDynamicStatusWithHumanReadableDescQuery |
Arguments:
| Name |
Required |
Type |
Default |
| theQuery |
Required |
query |
|
| columnName |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REPLACEDYNAMICSTATUSWITHHUMANREADABLEDESCSTRING |
| function ReplaceDynamicStatusWithHumanReadableDescString |
Arguments:
| Name |
Required |
Type |
Default |
| statusString |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RUNANDCACHEELEMENT |
| function RunAndCacheElement |
Arguments:
| Name |
Required |
Type |
Default |
| cachePageID |
Required |
numeric |
|
| cacheSubsiteID |
Required |
numeric |
|
| cacheParentID |
Required |
numeric |
|
| controlName |
Required |
string |
|
| cacheFileName |
Required |
string |
|
| isWIP |
Required |
boolean |
|
| OutputType |
Required |
string |
|
| OutputFormat |
Required |
string |
|
| ShareType |
Required |
numeric |
|
| wantStatusUpdate |
Required |
boolean |
|
| deleteBeforeWrite |
Required |
boolean |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a CacheResults object |
| Description: |
|
|
|
| USECACHEFILE |
| function UseCacheFile |
Arguments:
| Name |
Required |
Type |
Default |
| cacheFileName |
Required |
string |
|
| containsCFML |
Required |
boolean |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| USEMEMORYCACHE |
| function UseMemoryCache |
Arguments:
| Name |
Required |
Type |
Default |
| MemCacheName |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WRITECACHE |
| function WriteCache |
Arguments:
| Name |
Required |
Type |
Default |
| cacheFileName |
Required |
string |
|
| cacheContents |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
writes the given contents to create or update a file with the given filename |
| Description: |
|
|
|
|
| env |
| struct |
| GETADFPATH |
| function getADFpath |
| Arguments: | none |
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPROTOCOL |
| function getProtocol |
| Arguments: | none |
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSERVERNAME |
| function getServerName |
Arguments:
| Name |
Required |
Type |
Default |
| rtnProtocol |
Optional |
boolean |
true |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETWEBSERVICEUSERAGENT |
| function getWebServiceUserAgent |
| Arguments: | none |
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MARKAPPCHANGE |
| function MarkAppChange |
Arguments:
| Name |
Required |
Type |
Default |
| Fields |
Required |
string |
|
| Replicate |
Optional |
boolean |
1 |
| RemoteOnly |
Optional |
boolean |
0 |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
notifies the environment (and ROPS in a cluster) that a change has happened at the SITE level. Returns the timestamp (tick count) used for marking the change. |
| Description: |
|
|
|
| MARKCUSTOMERCHANGE |
| function MarkCustomerChange |
Arguments:
| Name |
Required |
Type |
Default |
| Fields |
Required |
string |
|
| Replicate |
Optional |
numeric |
1 |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
notifies the environment (and ROPS in a cluster) that a change has happened at the CUSTOMER level. Returns the timestamp (tick count) used for marking the change. |
| Description: |
|
|
|
| MARKOBJECTCHANGE |
| function MarkObjectChange |
Arguments:
| Name |
Required |
Type |
Default |
| ActionCode |
Required |
numeric |
|
| ObjectIDList |
Required |
string |
|
| Replicate |
Optional |
numeric |
1 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
notifies the environment (and ROPS in a cluster) that an object change has happened. (equivalent of mark-object-change.cfm from 4.x) |
| Description: |
|
|
|
| RELOADDEFAULTCONTRIBUTORTYPE |
| function ReloadDefaultContributorType |
Arguments:
| Name |
Required |
Type |
Default |
| Replicate |
Optional |
numeric |
1 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RESTORESUBSITECONTEXT |
| function restoreSubsiteContext |
Arguments:
| Name |
Required |
Type |
Default |
| savedState |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Takes a value returned by setSubsiteContext and restores the subsite context it specifies. |
| Description: |
|
|
|
| SETSUBSITECONTEXT |
| function setSubsiteContext |
Arguments:
| Name |
Required |
Type |
Default |
| subsiteID |
Required |
numeric |
|
| includeSecurityObject |
Optional |
boolean |
yes |
| throwIfUnknownSubsite |
Optional |
boolean |
1 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETSUBSITECONTEXTBYURL |
| function setSubsiteContextByURL |
Arguments:
| Name |
Required |
Type |
Default |
| subsiteURL |
Required |
string |
|
| includeSecurityObject |
Optional |
boolean |
yes |
| throwIfUnknownSubsite |
Optional |
boolean |
1 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Changes the active subsite context according to the passed subsiteID, optionally changing subsite security too. Returns the ID of the PREVIOUSLY CURRENT subsite, or 0 if the requested subsite was already current, so no change was made. |
| Description: |
|
|
|
| UPDATEREQUESTCONTEXT |
| function updateRequestContext |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATETHREADCOUNTS |
| function updateThreadCounts |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| file |
| struct |
| CHECKSYNCCOMMONSPOTUNCPATH |
| function CheckSyncCommonSpotUNCPath |
Arguments:
| Name |
Required |
Type |
Default |
| Directory |
Required |
string |
|
| testFile |
Optional |
boolean |
yes |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEDIRECTORY |
| function createDirectory |
Arguments:
| Name |
Required |
Type |
Default |
| Directory |
Required |
string |
|
| wantRethrow |
Optional |
boolean |
no |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DOFILEUPLOAD |
| function doFileUpload |
Arguments:
| Name |
Required |
Type |
Default |
| destination |
Required |
string |
|
| filefield |
Required |
string |
|
| replicate |
Required |
numeric |
|
| newfilename |
Optional |
string |
[empty string] |
| targetSubsiteID |
Optional |
numeric |
[runtime expression] |
| skipTestList |
Optional |
string |
uploadPermissionCheck,encryptedModuleCheck,tagNameCheck |
| mode |
Optional |
string |
775 |
| attributes |
Optional |
string |
Normal |
| nameconflict |
Optional |
string |
MakeUnique |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDIRECTORYLISTING |
| function getDirectoryListing |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
| filter |
Optional |
string |
[empty string] |
| nameField |
Optional |
string |
Name |
| typeField |
Optional |
string |
Type |
| dateField |
Optional |
string |
[empty string] |
| sizeField |
Optional |
string |
[empty string] |
| md5Field |
Optional |
string |
[empty string] |
| dirField |
Optional |
string |
[empty string] |
| lcNameField |
Optional |
string |
[empty string] |
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFILETIMESTAMP |
| function getFileTimestamp |
Arguments:
| Name |
Required |
Type |
Default |
| Directory |
Required |
string |
|
| FileName |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTMPDIR |
| function GetTmpDir |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISDIR |
| function isDir |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| freshnessreminder |
| struct |
| SAVEBYATTRIBUTES |
| function saveByAttributes |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| reminderID |
Required |
numeric |
|
| userGroupID |
Required |
string |
|
| type |
Required |
string |
|
| title |
Required |
string |
|
| description |
Required |
string |
|
| isPublic |
Required |
boolean |
|
| date |
Optional |
string |
[empty string] |
| daysBeforeAfter |
Optional |
numeric |
0 |
| validateDateInFuture |
Optional |
boolean |
1 |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Saves a new Freshness Reminder or updates an existing Freshness Reminder. |
| Description: |
|
|
|
|
| html |
| struct |
| CHECKBOX |
| function CheckBox |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Optional |
Any |
|
| value |
Optional |
Any |
|
| checkExpr |
Optional |
Any |
|
| args |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECSBLUEPAGE |
| function CreateCSBluePage |
Arguments:
| Name |
Required |
Type |
Default |
| message |
Required |
string |
|
| pagetitle |
Required |
string |
|
| includeNewWindowJS |
Optional |
boolean |
NO |
| showCopyright |
Optional |
boolean |
YES |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns html for CommonSpot warning page. |
| Description: |
|
|
|
| DECODEENTITIES |
| function decodeEntities |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ENCODETOENTITIES |
| function encodeToEntities |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Optional |
Any |
|
| ignoreExisting |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCAPE |
| function escape |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Required |
string |
|
| majorChars |
Optional |
boolean |
1 |
| newlines |
Optional |
boolean |
0 |
| multiSpaces |
Optional |
boolean |
0 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Does basic escaping of a string for presentation as HTML. |
| Description: |
|
|
|
| ESCAPEARRAYSTRUCTFIELDS |
| function escapeArrayStructFields |
Arguments:
| Name |
Required |
Type |
Default |
| array |
Required |
array |
|
| htmlFields |
Optional |
string |
[empty string] |
| jsFields |
Optional |
string |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Modifies passed array of structs, html and js escaping requested fields in each one. |
| Description: |
|
|
|
| ESCAPEJS |
| function escapeJs |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Escapes a string for use in javascript. |
| Description: |
|
|
|
| ESCAPEQUERY |
| function escapeQuery |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
query |
|
| columns |
Optional |
string |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
HTML escapes passed query. Can pass a list of columns to process, otherwise figures it out from the query. If column type metadata is available, only string columns are processed, else all. |
| Description: |
|
|
|
| ESCAPESTRUCTFIELDS |
| function escapeStructFields |
Arguments:
| Name |
Required |
Type |
Default |
| struct |
Required |
struct |
|
| htmlFields |
Optional |
string |
[empty string] |
| jsFields |
Optional |
string |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Modifies passed struct, html and js escaping requested fields. Handles single level structs only (siple values). |
| Description: |
|
|
|
| GETADMINHTMLHEAD |
| function GetAdminHtmlHead |
Arguments:
| Name |
Required |
Type |
Default |
| title |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns html for Administration page head. |
| Description: |
|
|
|
| GETSELECTKEYWORDHTML |
| function GetSelectKeywordHtml |
Arguments:
| Name |
Required |
Type |
Default |
| keywords |
Required |
string |
|
| reqText |
Optional |
string |
[empty string] |
| subsiteURL |
Optional |
string |
[empty string] |
| subsiteURLField |
Optional |
string |
[empty string] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns html for Select Keyword in Legacy dialog. |
| Description: |
|
|
|
| OPTION |
| function Option |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Optional |
Any |
|
| checkExpr |
Optional |
Any |
|
| display |
Optional |
Any |
|
| args |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RADIO_BUTTON |
| function Radio_Button |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Optional |
Any |
|
| value |
Optional |
Any |
|
| checkExpr |
Optional |
Any |
|
| args |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RENDERDBLIST |
| function RenderDbList |
Arguments:
| Name |
Required |
Type |
Default |
| fieldName |
Required |
string |
|
| selectedDB |
Optional |
string |
SQLServer |
| databaseList |
Optional |
string |
[runtime expression] |
| bHideIfOne |
Optional |
boolean |
false |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns html for Database List. |
| Description: |
|
|
|
| UNESCAPE |
| function unescape |
Arguments:
| Name |
Required |
Type |
Default |
| string |
Required |
string |
|
| majorChars |
Optional |
boolean |
1 |
| brTags |
Optional |
boolean |
1 |
| multiSpaces |
Optional |
boolean |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Undoes basic html escaping done by Server.CommonSpot.udf.html.escape. |
| Description: |
|
|
|
|
| httputil |
| struct |
| GETHTTPCOOKIES |
| function getHTTPCookies |
Arguments:
| Name |
Required |
Type |
Default |
| resStruct |
Required |
struct |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Get HTTP cookies. |
| Description: |
|
|
|
| MAKECFHTTPREQUEST |
| function makeCFHTTPRequest |
Arguments:
| Name |
Required |
Type |
Default |
| reqStruct |
Required |
struct |
|
| cookiesStruct |
Required |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Make CFHTTP call. |
| Description: |
|
|
|
| MAKEHTTPREQUEST |
| function makeHTTPRequest |
Arguments:
| Name |
Required |
Type |
Default |
| reqStruct |
Required |
struct |
|
| cookiesStruct |
Optional |
any |
[empty string] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Makes a CFHTTP request to the specified URL. |
| Description: |
|
|
|
| VERIFYURL |
| function verifyURL |
Arguments:
| Name |
Required |
Type |
Default |
| url |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
makes http request by get to the given URL and returns structure with information. |
| Description: |
|
|
|
|
| index |
| struct |
| BUILDROPSCOLLECTIONS |
| function BuildROPSCollections |
Arguments:
| Name |
Required |
Type |
Default |
| sitesDS |
Required |
string |
|
| skipSites |
Optional |
string |
[empty string] |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECOLLECTION |
| function CreateCollection |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| Path |
Required |
string |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECOLLECTION |
| function DeleteCollection |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INDEXCUSTOMELEMENT |
| function IndexCustomElement |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| FormID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INDEXINGENABLED |
| function IndexingEnabled |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Optional |
string |
issue8512 |
| SubsiteID |
Optional |
numeric |
-1 |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INDEXONEPAGE |
| function IndexOnePage |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| PageID |
Required |
numeric |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INDEXSUBSITE |
| function IndexSubsite |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| SubsiteID |
Required |
numeric |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INDEXUPLOADEDDOC |
| function IndexUploadedDoc |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
String |
|
| PageID |
Required |
numeric |
|
| SubsiteID |
Required |
numeric |
|
| Title |
Required |
string |
|
| Description |
Required |
string |
|
| FileName |
Required |
string |
|
| DateLastModified |
Required |
string |
|
| OwnerID |
Required |
numeric |
|
| Language |
Optional |
string |
english |
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| OPTIMIZECOLLECTION |
| function OptimizeCollection |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| QUEUEINDEXREQUEST |
| function QueueIndexRequest |
Arguments:
| Name |
Required |
Type |
Default |
| Method |
Required |
string |
|
| Args |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REBUILDCOLLECTION |
| function RebuildCollection |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| CollectionDir |
Required |
string |
|
| SiteID |
Required |
numeric |
|
| SubsiteList |
Required |
string |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVECUSTOMELEMENTINSTANCE |
| function RemoveCustomElementInstance |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
String |
|
| FormID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVECUSTOMELEMENTTYPE |
| function RemoveCustomElementType |
Arguments:
| Name |
Required |
Type |
Default |
| FormID |
Required |
numeric |
|
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVEPAGE |
| function RemovePage |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
String |
|
| FileName |
Required |
String |
|
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVESUBSITES |
| function RemoveSubsites |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
String |
|
| SubsiteIDList |
Required |
String |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REPAIRCOLLECTION |
| function RepairCollection |
Arguments:
| Name |
Required |
Type |
Default |
| CollectionName |
Required |
string |
|
| LocalOnly |
Optional |
numeric |
0 |
| RunInBackground |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| jobmanager |
| struct |
| ADDMESSAGE |
| function addMessage |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| message |
Required |
string |
|
| messageType |
Optional |
string |
message |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Adds a message to the results array. |
| Description: |
|
|
|
| CREATE |
| function create |
Arguments:
| Name |
Required |
Type |
Default |
| methodName |
Required |
string |
|
| callbackURL |
Required |
string |
|
| occurance |
Required |
string |
|
| scope |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Creates the structure for this new job and returns the ID of the same. This will be called from the Tools methods. |
| Description: |
|
|
|
| DELETE |
| function delete |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Deletes the specified job. |
| Description: |
|
|
|
| EXECUTE |
| function execute |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Executes the specified job. This will be called from the Tools methods. |
| Description: |
|
|
|
| EXISTS |
| function exists |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns true is the specified job exists, false otherwise. |
| Description: |
|
|
|
| GETLIST |
| function getList |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns status information about all known jobs for the specified scope. |
| Description: |
|
|
|
| GETPROPERTY |
| function getProperty |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| propertyName |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Returns the value of the specified property of the job. |
| Description: |
|
|
|
| GETSTATUS |
| function getStatus |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| startMessageNumber |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns the status of the specified job. |
| Description: |
|
|
|
| INCREMENTCOUNT |
| function incrementCount |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Adds 1 to the current count. |
| Description: |
|
|
|
| INCREMENTSUCCESSCOUNT |
| function incrementSuccessCount |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Adds 1 to the success count. |
| Description: |
|
|
|
| ISACTIVE |
| function isActive |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns true is the status of the specified job is either 'Running' or 'Initializing', false otherwise. |
| Description: |
|
|
|
| POPULATEJOB |
| function populateJob |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| privateData |
Required |
any |
|
| refreshInterval |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Populates the job structure with specified values. |
| Description: |
|
|
|
| REMOVEIDLEJOBS |
| function removeIdleJobs |
Arguments:
| Name |
Required |
Type |
Default |
| idleDuration |
Optional |
numeric |
2880 |
| scope |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Removes all jobs that have been idle for longer than the time period specified. |
| Description: |
|
|
|
| SETSTATUS |
| function setStatus |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| status |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Sets the status of the job i.e. 'Running', 'Initializing', 'Complete', 'Canceled' or 'Error'. |
| Description: |
|
|
|
|
| js |
| struct |
| CS_JSSTRINGFORMAT |
| function CS_JSStringFormat |
Arguments:
| Name |
Required |
Type |
Default |
| src |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
No |
| DisplayName: |
|
| Hint: |
wrapper around JSStringFormat to guard against some oddball extended characters - use in place of JSStringFormat |
| Description: |
|
|
|
| ESCAPESTRING |
| function EscapeString |
Arguments:
| Name |
Required |
Type |
Default |
| source |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCAPESTRINGFORJS |
| function EscapeStringForJS |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| EVENT_CANCEL |
| function Event_Cancel |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| EVENT_PARAM |
| function Event_Param |
Arguments:
| Name |
Required |
Type |
Default |
| other |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| keywords |
| struct |
| ADDKEYWORDSTOOBJECT |
| function addKeywordsToObject |
Arguments:
| Name |
Required |
Type |
Default |
| keywordList |
Required |
string |
|
| objectID |
Required |
numeric |
|
| checkExisting |
Required |
boolean |
|
| keywordType |
Required |
string |
|
| tableName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Adds all passed keywords to requested obejct. |
| Description: |
|
|
|
| REMOVEOBJECTKEYWORDS |
| function removeObjectKeywords |
Arguments:
| Name |
Required |
Type |
Default |
| objectID |
Required |
numeric |
|
| keywordType |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETKEYWORDSFOROBJECT |
| function setKeywordsForObject |
Arguments:
| Name |
Required |
Type |
Default |
| keywordList |
Required |
string |
|
| objectID |
Required |
numeric |
|
| keywordType |
Required |
string |
|
| tableName |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Saves passed list of keywords, associating them with the passed objectID and userID. If user doesn't have rights to add new keywords, returns list of requested ones that don't yet exist and couldn't be assigned. |
| Description: |
|
|
|
|
| linkmgt |
| struct |
| CHECKEMAILADDRESS |
| function checkEmailAddress |
Arguments:
| Name |
Required |
Type |
Default |
| address |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
check to see if the given string is a valid email address - returns a link status value (1=linkValid, 2=linkInvalid, 4=linkSyntaxValid) |
| Description: |
|
|
|
| EXTRACTLINKFROMWDDX |
| function extractLinkFromWDDX |
Arguments:
| Name |
Required |
Type |
Default |
| wddxBlock |
Required |
string |
|
| fieldName |
Optional |
string |
linkURL |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PARSESINGLELINK |
| function parseSingleLink |
Arguments:
| Name |
Required |
Type |
Default |
| sourceData |
Required |
string |
|
| embeddedObject |
Optional |
boolean |
no |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REFRESHLOCALLINKSTATUS |
| function refreshLocalLinkStatus |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Optional |
numeric |
0 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
updates status for all local links (no HTTP requests used) |
| Description: |
|
|
|
| RESOLVEIMAGESRC |
| function resolveImageSrc |
Arguments:
| Name |
Required |
Type |
Default |
| URL |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
wrapper around resolve-image |
| Description: |
|
|
|
| RESOLVEURL |
| function resolveURL |
Arguments:
| Name |
Required |
Type |
Default |
| URL |
Required |
string |
|
| PageID |
Optional |
numeric |
0 |
| forceDynamic |
Optional |
boolean |
no |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
wrapper around ct-decipher-linkurl |
| Description: |
|
|
|
| UPDATESINGLELINK |
| function updateSingleLink |
Arguments:
| Name |
Required |
Type |
Default |
| originalData |
Required |
string |
|
| originalPageID |
Required |
numeric |
|
| newPageID |
Required |
numeric |
|
| newFilename |
Required |
string |
|
| newSubsiteID |
Required |
numeric |
|
| newPageType |
Required |
numeric |
|
| newUploaded |
Required |
numeric |
|
| newLinkURL |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEWDDXFIELD |
| function updateWDDXField |
Arguments:
| Name |
Required |
Type |
Default |
| wddxBlock |
Required |
string |
|
| newValue |
Required |
string |
|
| fieldName |
Optional |
string |
linkURL |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| menucache |
| struct |
| CLEARMENUCACHE_DIR |
| function ClearMenuCache_Dir |
Arguments:
| Name |
Required |
Type |
Default |
| SubsiteDir |
Required |
String |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLEARMENUCACHE_PAGE |
| function ClearMenuCache_Page |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
| Path |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| mx |
| struct |
| CSCLEARREQUEST |
| function csClearRequest |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CSEXECUTE |
| function csExecute |
Arguments:
| Name |
Required |
Type |
Default |
| cmd |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DOCSDUMP |
| function doCSDump |
Arguments:
| Name |
Required |
Type |
Default |
| structures |
Optional |
string |
|
| returnInVar |
Optional |
numeric |
0 |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DODUMP |
| function doDump |
Arguments:
| Name |
Required |
Type |
Default |
| var |
Required |
any |
|
| label |
Optional |
string |
no label |
| returnInVar |
Optional |
numeric |
0 |
| expandThis |
Optional |
boolean |
false |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DOFLUSH |
| function doFlush |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DOLOG |
| function doLog |
Arguments:
| Name |
Required |
Type |
Default |
| comment |
Optional |
string |
|
| forceStackTrace |
Optional |
numeric |
1 |
| filename |
Optional |
string |
errors.log |
| useDatePrefix |
Optional |
numeric |
1 |
| exception |
Optional |
any |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETEXECUTIONSTACK |
| function getExecutionStack |
Arguments:
| Name |
Required |
Type |
Default |
| full |
Optional |
boolean |
0 |
| html |
Optional |
boolean |
0 |
| comment |
Optional |
string |
[empty string] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| STACKTRACETEXT |
| function stackTraceText |
Arguments:
| Name |
Required |
Type |
Default |
| cfcatchStruct |
Required |
any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns text dump of stack in passed cfcatch. |
| Description: |
|
|
|
| WRITEDUMPFILE |
| function writeDumpFile |
Arguments:
| Name |
Required |
Type |
Default |
| var |
Required |
any |
|
| label |
Required |
string |
|
| filePath |
Required |
string |
|
| overwriteFile |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| page |
| struct |
| CHECKLOCK |
| function checkLock |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
any |
|
| throwIfLocked |
Optional |
boolean |
1 |
| msgAsHTML |
Optional |
boolean |
0 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEDATASEEALSO |
| function DeleteDataSeeAlso |
Arguments:
| Name |
Required |
Type |
Default |
| ID |
Required |
numeric |
|
| PageID |
Required |
numeric |
|
| ForReplication |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DOURLREPLACEMENTS |
| function DoURLReplacements |
Arguments:
| Name |
Required |
Type |
Default |
| GeneratedContent |
Required |
string |
|
| PatternURL |
Required |
string |
|
| ReplacementURL |
Required |
string |
|
| IsStatic |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCACHEFILENAME |
| function GetCacheFilename |
Arguments:
| Name |
Required |
Type |
Default |
| CacheStatus |
Required |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCHILDPAGES |
| function GetChildPages |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
String |
|
| TemplatesOnly |
Optional |
boolean |
true |
| ChildrenOnly |
Optional |
boolean |
false |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETELEMENTWIPLISTS |
| function GetElementWIPLists |
Arguments:
| Name |
Required |
Type |
Default |
| PageWIPLists |
Required |
struct |
|
| ControlID |
Required |
numeric |
|
| ItemID |
Optional |
string |
[empty string] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETWIPLISTS |
| function GetWIPLists |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
| RenderMode |
Required |
string |
|
| DataSource |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOCKINFO |
| function lockInfo |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOCKINFOTEXT |
| function lockInfoText |
Arguments:
| Name |
Required |
Type |
Default |
| info |
Required |
struct |
|
| includeUsers |
Optional |
boolean |
true |
| includeActions |
Optional |
boolean |
false |
| asHTML |
Optional |
boolean |
false |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PAGETYPESTRING |
| function pageTypeString |
Arguments:
| Name |
Required |
Type |
Default |
| pageType |
Required |
numeric |
|
| isUploaded |
Required |
boolean |
|
| simple |
Optional |
boolean |
false |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| QUEUEBACKGROUNDCACHEREBUILD |
| function queueBackgroundCacheRebuild |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
queues the given page for a background re-rendering (ct-make-cache) |
| Description: |
|
|
|
| TEMPLATEINHERITANCE |
| function templateInheritance |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Looks up all the templates from which an instance or template is derived. Returns a struct with an 'inheritanceWhereClause' and an 'inheritanceList' - a comma delimited list. |
| Description: |
|
|
|
| TEMPLATEINHERITANCELISTSIMPLE |
| function templateInheritanceListSimple |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the template inheriticance list for the requested pageID, including that pageID. DOES NOT SUPPORT versioning, and shouldn't be used in that context. |
| Description: |
|
|
|
| VISIBLEWIPITEMS |
| function VisibleWIPItems |
Arguments:
| Name |
Required |
Type |
Default |
| PageWIPLists |
Required |
struct |
|
| Mode |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| remote |
| struct |
| CHECKSERVERSTATUS |
| function CheckServerStatus |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
post server status change to other servers |
| Description: |
|
|
|
| INTERNAL_PROCESSREQUESTS |
| function Internal_ProcessRequests |
Arguments:
| Name |
Required |
Type |
Default |
| TableName |
Required |
string |
|
| DataSource |
Required |
string |
|
| Mode |
Required |
numeric |
|
| QueueBackground |
Required |
boolean |
|
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
*internal* - method to process a collection of requests |
| Description: |
|
|
|
| LOGBACKGROUNDEVENT |
| function logBackgroundEvent |
Arguments:
| Name |
Required |
Type |
Default |
| eventType |
Required |
string |
|
| details |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
add a log entry for a background event |
| Description: |
|
|
|
| PROCESSBACKGROUNDREQUESTS |
| function ProcessBackgroundRequests |
Arguments:
| Name |
Required |
Type |
Default |
| Scope |
Required |
string |
|
| RequestMode |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Processed any background requests found in RemoteRequests (for this server) |
| Description: |
|
|
|
| PROCESSFILEACTIONQUEUE |
| function ProcessFileActionQueue |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
processes the FileActionQueue for this site |
| Description: |
|
|
|
| PROCESSREMOTEREQUESTS |
| function processRemoteRequests |
Arguments:
| Name |
Required |
Type |
Default |
| Scope |
Required |
string |
|
| forceProcessing |
Optional |
boolean |
false |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
checks the RemoteRequests table to see if we have work to do |
| Description: |
|
|
|
| QUEUEREMOTEREQUEST |
| function QueueRemoteRequest |
Arguments:
| Name |
Required |
Type |
Default |
| Scope |
Required |
string |
|
| Package |
Required |
string |
|
| Method |
Required |
string |
|
| Args |
Required |
any |
|
| TargetServers |
Optional |
string |
[empty string] |
| DataSource |
Optional |
string |
[empty string] |
| RequestMode |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
packages and queues a request for remote server(s) |
| Description: |
|
|
|
| SCHEDULEBACKGROUNDJOB |
| function ScheduleBackgroundJob |
Arguments:
| Name |
Required |
Type |
Default |
| RequestMode |
Required |
numeric |
|
| ThreadID |
Optional |
numeric |
1 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
put in a schedule entry for a background task |
| Description: |
|
|
|
|
| scheduledjob |
| struct |
| DECODEFREQUENCYANDINTERVAL |
| function decodeFrequencyAndInterval |
Arguments:
| Name |
Required |
Type |
Default |
| interval |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct after decoding the interval string. |
| Description: |
|
|
|
| ENCODEFREQUENCYANDINTERVAL |
| function encodeFrequencyAndInterval |
Arguments:
| Name |
Required |
Type |
Default |
| frequency |
Required |
string |
|
| intervalSeconds |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a string after encoding the frequency and interval so that it can passed to the inerval attribute of CFSCHEDULE. |
| Description: |
|
|
|
| GETJOBDEFINITION |
| function getJobDefinition |
Arguments:
| Name |
Required |
Type |
Default |
| definitionID |
Required |
numeric |
|
| scope |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the job definition record for the given job definition ID. |
| Description: |
|
|
|
| GETJOBINSTANCEPROPERTIES |
| function getJobInstanceProperties |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
numeric |
|
| scope |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Get the scheduled job properties. |
| Description: |
|
|
|
| GETJOBINSTANCES |
| function getJobInstances |
Arguments:
| Name |
Required |
Type |
Default |
| dsn |
Required |
string |
|
| table |
Required |
string |
|
| serverID |
Required |
numeric |
|
| jobID |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Get the scheduled job records from the specified datasource. |
| Description: |
|
|
|
| GETSCHEDULEDJOBSINCF |
| function getScheduledJobsInCF |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTABLEANDDSNINFO |
| function getTableAndDSNInfo |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Required |
string |
|
| DSN |
Optional |
string |
[empty string] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns the table and datasource info for the specified scope. |
| Description: |
|
|
|
| GETTASKNAMEANDURL |
| function getTaskNameAndURL |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
numeric |
|
| scope |
Required |
string |
|
| dsn |
Optional |
string |
[empty string] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Creates the taskname and task url based on the scheduledJobID. |
| Description: |
|
|
|
| ISCFDATASAMEASCSDATA |
| function isCFDataSameAsCSData |
Arguments:
| Name |
Required |
Type |
Default |
| schedInfoInCF |
Required |
struct |
|
| interval |
Required |
string |
|
| startDate |
Required |
string |
|
| startTime |
Required |
string |
|
| endDate |
Required |
string |
|
| endTime |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns true if cf scheduled task values as similar to that in database, false otherwise. |
| Description: |
|
|
|
| PROCESSJOBSBYDSN |
| function processJobsByDSN |
Arguments:
| Name |
Required |
Type |
Default |
| dsn |
Required |
String |
|
| scope |
Required |
String |
|
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVEEXTRAJOBS |
| function removeExtraJobs |
Arguments:
| Name |
Required |
Type |
Default |
| validJobs |
Required |
Struct |
|
| taskPrefix |
Required |
String |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVEFROMCF |
| function removeFromCF |
Arguments:
| Name |
Required |
Type |
Default |
| taskName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Removes the specified job to ColdFusion. |
| Description: |
|
|
|
| SETJOBMANAGERJOBSTATUS |
| function setJobManagerJobStatus |
Arguments:
| Name |
Required |
Type |
Default |
| jobManagerJobID |
Required |
numeric |
|
| status |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Sets the status of scheduled job base on the job manager job id. |
| Description: |
|
|
|
| SETSCHEDJOBSTATUS |
| function setSchedJobStatus |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Required |
string |
|
| id |
Required |
numeric |
|
| startTime |
Required |
string |
|
| status |
Required |
string |
|
| message |
Required |
string |
|
| jobManagerJobID |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Sets the status of the specified job running on the current server. |
| Description: |
|
|
|
| SYNCHRONIZEJOBSINCF |
| function synchronizeJobsInCF |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Optional |
string |
[empty string] |
| id |
Optional |
numeric |
0 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Synchronizes the scheduled jobs in ColdFusion based on the specified parameters. |
| Description: |
|
|
|
| UPDATEINCF |
| function updateInCF |
Arguments:
| Name |
Required |
Type |
Default |
| taskName |
Required |
string |
|
| targetURL |
Required |
string |
|
| targetPort |
Required |
string |
|
| startDate |
Required |
string |
|
| startTime |
Required |
string |
|
| interval |
Required |
string |
|
| endDate |
Required |
string |
|
| endTime |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Adds/updates the specified job to ColdFusion. |
| Description: |
|
|
|
|
| search |
| struct |
| COLLECTIONEXISTS |
| function CollectionExists |
Arguments:
| Name |
Required |
Type |
Default |
| collectionName |
Required |
string |
|
| collectionDir |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CSCOLLECTION |
| function CSCollection |
Arguments:
| Name |
Required |
Type |
Default |
| ACTION |
Required |
string |
|
| COLLECTION |
Optional |
string |
[empty string] |
| PATH |
Optional |
string |
[empty string] |
| LANGUAGE |
Optional |
string |
English |
| NAME |
Optional |
string |
[empty string] |
| CATEGORIES |
Optional |
string |
no |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CSINDEX |
| function CSIndex |
Arguments:
| Name |
Required |
Type |
Default |
| COLLECTION |
Required |
string |
|
| ACTION |
Required |
string |
|
| KEY |
Required |
string |
|
| QUERY |
Optional |
any |
[empty string] |
| TYPE |
Optional |
string |
file |
| BODY |
Optional |
string |
[empty string] |
| TITLE |
Optional |
string |
[empty string] |
| CUSTOM1 |
Optional |
string |
[empty string] |
| CUSTOM2 |
Optional |
string |
[empty string] |
| CUSTOM3 |
Optional |
string |
[empty string] |
| CUSTOM4 |
Optional |
string |
[empty string] |
| EXTENSIONS |
Optional |
string |
.* |
| LANGUAGE |
Optional |
string |
English |
| CATEGORY |
Optional |
string |
[empty string] |
| CATEGORYTREE |
Optional |
string |
[empty string] |
| URLPATH |
Optional |
string |
[empty string] |
| RECURSE |
Optional |
string |
no |
| STATUS |
Optional |
string |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CSSEARCH |
| function CSSearch |
Arguments:
| Name |
Required |
Type |
Default |
| Collection |
Required |
string |
|
| Criteria |
Optional |
string |
* |
| MaxRows |
Optional |
string |
All |
| Type |
Optional |
string |
simple |
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DROPCOLLECTION |
| function DropCollection |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| logError |
Optional |
boolean |
yes |
| ignoreException |
Optional |
boolean |
yes |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETARGSTEXT |
| function getArgsText |
Arguments:
| Name |
Required |
Type |
Default |
| args |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns text rendering of passed args struct. |
| Description: |
|
|
|
| GETRESULTPAGEIDS |
| function getResultPageIDs |
Arguments:
| Name |
Required |
Type |
Default |
| resultQuery |
Required |
query |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Extracts pageIDs from passed result of CSSearch |
| Description: |
|
|
|
| GETWILDCARDSEARCHSTRING |
| function getWildcardSearchString |
Arguments:
| Name |
Required |
Type |
Default |
| searchString |
Required |
string |
|
| searchOperator |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| HANDLESEARCHERROR |
| function HandleSearchError |
Arguments:
| Name |
Required |
Type |
Default |
| methodName |
Required |
string |
|
| args |
Required |
struct |
|
| cfcatch_message |
Optional |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Logs all errors, returns true unless on a ROPS; caller can rethrow or show UI in response. Not used for CSSearch; its callers get raw cf errors. |
| Description: |
|
|
|
| TESTCOLLECTION |
| function testCollection |
Arguments:
| Name |
Required |
Type |
Default |
| collection |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Returns 0 if collection is ok, else numeric failure code. |
| Description: |
|
|
|
| TESTFULLTEXTSEARCHENGINECONNECTION |
| function testFullTextSearchEngineConnection |
Arguments:
| Name |
Required |
Type |
Default |
| indexEngineType |
Optional |
string |
verity |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
test if the full-text search engine is on |
| Description: |
|
|
|
| VERIFYCONNECTION |
| function VerifyConnection |
Arguments:
| Name |
Required |
Type |
Default |
| cfcatch_message |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
verify if the exception is from Unable to connect to the search service |
| Description: |
|
|
|
|
| security |
| struct |
| AUTHOROK |
| function AuthorOK |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns 1(TRUE) if authoring is permitted (by license) AND enabled on this server |
| Description: |
|
|
|
| CALLSECURITYPAGE |
| function CallSecurityPage |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| dontCheckLock |
Optional |
boolean |
1 |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKFIELDSECURITY |
| function checkFieldSecurity |
Arguments:
| Name |
Required |
Type |
Default |
| fieldID |
Required |
string |
|
| userGroupList |
Optional |
string |
current |
| fieldParams |
Optional |
any |
[empty string] |
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces check-field-security.cfm for checking (metadata/form) field-level permissions |
| Description: |
|
|
|
| CHECKPERMISSION |
| function CheckPermission |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Required |
string |
|
| perm |
Required |
string |
|
| subsiteID |
Optional |
numeric |
0 |
| pageID |
Optional |
numeric |
0 |
| controlID |
Optional |
numeric |
0 |
| userGroupList |
Optional |
string |
[empty string] |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
No |
| DisplayName: |
|
| Hint: |
convenience wrapper for various security levels - checks given permission for current user |
| Description: |
|
|
|
| FILTERSUBSITEIDLISTBYPERMISSION |
| function filterSubsiteIDListByPermission |
Arguments:
| Name |
Required |
Type |
Default |
| subsiteIDList |
Required |
string |
|
| permission |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns passed subsiteIDList with ones user doesn't have passed permission for removed. |
| Description: |
|
|
|
| GETAVAILABLECONTROLS |
| function GetAvailableControls |
Arguments:
| Name |
Required |
Type |
Default |
| elementState |
Optional |
string |
0 |
| extSQL |
Optional |
string |
[empty string] |
| showInactiveCE |
Optional |
boolean |
false |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMELEMENTMASKRIGHTS |
| function getCustomElementMaskRights |
Arguments:
| Name |
Required |
Type |
Default |
| elementTypeID |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns 'create mask' level (none=0, private=1, public=2) |
| Description: |
|
|
|
| GETCUSTOMELEMENTPERMISSIONS |
| function getCustomElementPermissions |
Arguments:
| Name |
Required |
Type |
Default |
| elementTypeID |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces check-user-security.cfm for checking custom element permissions |
| Description: |
|
|
|
| GETELEMENTSECURITY |
| function getElementSecurity |
Arguments:
| Name |
Required |
Type |
Default |
| ControlID |
Required |
numeric |
|
| ControlTypeID |
Required |
numeric |
|
| ElementInfoStruct |
Optional |
any |
[empty string] |
| UserObject |
Optional |
struct |
[runtime expression] |
| setControlVars |
Optional |
boolean |
no |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces security-control.cfm, returns new or updated ElementInfo structure - WARNING - many side effects!! |
| Description: |
|
|
|
| GETMENUCONTEXTTIMESTAMP |
| function getMenuContextTimestamp |
| Arguments: | none |
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
No |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEMENUCLASSES |
| function getPageMenuClasses |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
No |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| HASCUSTOMELEMENTPERMISSION |
| function hasCustomElementPermission |
Arguments:
| Name |
Required |
Type |
Default |
| elementTypeID |
Required |
numeric |
|
| permission |
Required |
string |
|
| userGroupList |
Optional |
string |
current |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces check-user-security.cfm for checking custom element permissions |
| Description: |
|
|
|
| ISANONREADABLE |
| function isAnonReadable |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns 1(TRUE) if the given pageID is readable by anonymous |
| Description: |
|
|
|
| ISCONTRIBUTOR |
| function isContributor |
Arguments:
| Name |
Required |
Type |
Default |
| userGroupID |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns true if the given user/group is a contributor (most groups always say yes, at least for now |
| Description: |
|
|
|
| NT_CHECKFORCEDAUTH |
| function NT_CheckForcedAuth |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| READABLEPAGESLIST |
| function readablePagesList |
Arguments:
| Name |
Required |
Type |
Default |
| inList |
Required |
string |
|
| userGroupList |
Optional |
string |
0 |
| checkCustomElements |
Optional |
boolean |
1 |
| returnType |
Optional |
string |
list |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
restricts the given list of page IDs to only those readable by the given user/group list [replacement for readable-pages-filter.cfm] |
| Description: |
|
|
|
| READABLEPAGESQUERY |
| function readablePagesQuery |
Arguments:
| Name |
Required |
Type |
Default |
| origQuery |
Required |
query |
|
| origIDList |
Required |
String |
|
| readableByPgUser |
Optional |
boolean |
true |
| maxRows |
Optional |
numeric |
-1 |
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RELOADUSERSPERMSCACHES |
| function reloadUsersPermsCaches |
Arguments:
| Name |
Required |
Type |
Default |
| reloadAllServers |
Optional |
boolean |
no |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
reloads cache of CustomerPermissions table |
| Description: |
|
|
|
| UPDATEOBJECTOWNERSHIP |
| function UpdateObjectOwnership |
Arguments:
| Name |
Required |
Type |
Default |
| userObject |
Optional |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
No |
| DisplayName: |
|
| Hint: |
convenience method for handling object ownership list |
| Description: |
|
|
|
|
| site |
| struct |
| ADDDFVREC |
| function addDFVRec |
Arguments:
| Name |
Required |
Type |
Default |
| info |
Required |
struct |
|
| fieldID |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKDFVFIELDCOUNT |
| function checkDFVFieldCount |
Arguments:
| Name |
Required |
Type |
Default |
| qry |
Required |
query |
|
| fieldcount |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKDFVRECS |
| function checkDFVRecs |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
| fieldIDList |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKFICRECS |
| function checkFICRecs |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKFIELDDEFINITION |
| function CheckFieldDefinition |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKTAXONOMYENABLED |
| function CheckTaxonomyEnabled |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLEARMETADATACACHE |
| function clearMetadataCache |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECUSTOMELEMENT |
| function CreateCustomElement |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECUSTOMFIELDTYPE |
| function CreateCustomFieldType |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECUSTOMRENDERHANDLER |
| function CreateCustomRenderHandler |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEFIELDCOLLECTIONROOT |
| function CreateFieldCollectionRoot |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEFIELDDEFAULTVALUE |
| function CreateFieldDefaultValue |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
| useTransaction |
Optional |
boolean |
1 |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEFIELDDEFAULTVALUECORE |
| function CreateFieldDefaultValueCore |
Arguments:
| Name |
Required |
Type |
Default |
| passStruct |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEFIELDDEFINITION |
| function CreateFieldDefinition |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
| isXMLPubMfield |
Optional |
boolean |
false |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEFIELDMASK |
| function CreateFieldMask |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATETABDEFINITION |
| function CreateTabDefinition |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEIMPORTEDOBJECTS |
| function DeleteImportedObjects |
Arguments:
| Name |
Required |
Type |
Default |
| objectID |
Required |
numeric |
|
| dsn |
Optional |
Any |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELGCEINSTANCEDATA |
| function delGCEInstanceData |
Arguments:
| Name |
Required |
Type |
Default |
| elementTypeID |
Required |
numeric |
|
| dataPageID |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FIXDFVRECS |
| function fixDFVRecs |
Arguments:
| Name |
Required |
Type |
Default |
| mode |
Required |
string |
|
| formID |
Required |
numeric |
|
| pageID |
Required |
numeric |
|
| controlID |
Required |
numeric |
|
| versionState |
Required |
numeric |
|
| fieldIDList |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FIXFORMDATAINSERTCONFLICTS |
| function fixFormDataInsertConflicts |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
| fieldIDList |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FIXMULTIPLEROWSPERVERSIONSTATE |
| function fixMultipleRowsPerVersionState |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
no |
| DisplayName: |
|
| Hint: |
repairs data with multiple VersionID=2 records for the same field |
| Description: |
|
|
|
| GETCHARSET |
| function GetCharset |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDFVRECSFORFIELDCONSISTENCY |
| function getDFVRecsForFieldConsistency |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
| fieldIDList |
Required |
string |
|
| versionstate |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDFVRECSFORFIELDCOUNT |
| function getDFVRecsForFieldCount |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
| fieldIDList |
Required |
string |
|
| versionstate |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFICRECS |
| function getFICRecs |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
numeric |
|
| isXMLPublication |
Required |
boolean |
false |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFIELDTYPES |
| function GetFieldTypes |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETIDMAPPINGSTRUCT |
| function getIDMappingStruct |
Arguments:
| Name |
Required |
Type |
Default |
| objectGUID |
Required |
string |
|
| fromSource |
Optional |
boolean |
yes |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETIMPORTEDMAPPING |
| function GetImportedMapping |
Arguments:
| Name |
Required |
Type |
Default |
| listvalue |
Required |
String |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETINACTIVEIMPORTEDOBJECTS |
| function GetInactiveImportedObjects |
Arguments:
| Name |
Required |
Type |
Default |
| listvalue |
Optional |
String |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLOCALEINFO |
| function GetLocaleInfo |
Arguments:
| Name |
Required |
Type |
Default |
| justDefault |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSITELOCALDIR |
| function getSiteLocalDir |
Arguments:
| Name |
Required |
Type |
Default |
| userDSN |
Required |
string |
|
| siteDSN |
Required |
string |
|
| childDir |
Optional |
string |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTIDYCHARENCODING |
| function GetTidyCharEncoding |
Arguments:
| Name |
Required |
Type |
Default |
| strCharSet |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISPUBLICGETLIST |
| function IsPublicGetList |
Arguments:
| Name |
Required |
Type |
Default |
| bitlist |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISPUBLICGETOPTIONS |
| function IsPublicGetOptions |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOADCUSTOMAPPFRAMEWORK |
| function loadCustomAppFramework |
Arguments:
| Name |
Required |
Type |
Default |
| siteName |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAKEDFVRECSCONSISTENT |
| function makeDFVRecsConsistent |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| controlID |
Required |
numeric |
|
| versionstate |
Required |
numeric |
|
| formID |
Required |
numeric |
|
| fieldIDList |
Required |
string |
|
| data |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVEDFVRECS |
| function removeDFVRecs |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| controlID |
Required |
numeric |
|
| versionstate |
Required |
numeric |
|
| formID |
Required |
numeric |
|
| fieldIDList |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RENDERLOCALEDATETIME |
| function RenderLocaleDateTime |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REPAIRFORMWITHINCONSISTENTDATA |
| function repairFormWithInconsistentData |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Repairs the data for the specified form(s). |
| Description: |
|
|
|
| RESOLVEINPUTPARAMS |
| function ResolveInputParams |
Arguments:
| Name |
Required |
Type |
Default |
| inputParams |
Required |
struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETCUSTOMELEMENTSECURITY |
| function setCustomElementSecurity |
Arguments:
| Name |
Required |
Type |
Default |
| elementID |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECUSTOMRENDERHANDLER |
| function UpdateCustomRenderHandler |
Arguments:
| Name |
Required |
Type |
Default |
| initMap |
Required |
struct |
|
| updateByImportedObject |
Required |
boolean |
false |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEEXPORTEDOBJECTSTBL |
| function UpdateExportedObjectsTbl |
Arguments:
| Name |
Required |
Type |
Default |
| packageID |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WEBSERVERCONNECTIONTEST |
| function webServerConnectionTest |
Arguments:
| Name |
Required |
Type |
Default |
| testURL |
Required |
string |
|
| siteName |
Optional |
string |
[empty string] |
| siteDir |
Optional |
string |
[empty string] |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WEBSERVERCONNECTIONTESTFILENAME |
| function webServerConnectionTestFileName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WEBSERVERCONNECTIONTESTFILEWRITE |
| function webServerConnectionTestFileWrite |
Arguments:
| Name |
Required |
Type |
Default |
| siteName |
Required |
string |
|
| siteDir |
Required |
string |
|
| token |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| static |
| struct |
| GETDYNAMICPAGELIST |
| function getDynamicPageList |
Arguments:
| Name |
Required |
Type |
Default |
| pageList |
Optional |
string |
[empty string] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns list of pages known to be dynamic |
| Description: |
|
|
|
| GETHTTPBASE |
| function GetHTTPBase |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLOADERBASE |
| function GetLoaderBase |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISSTATICENABLED |
| function IsStaticEnabled |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| TRANSLATEDYNAMICREASONS |
| function TranslateDynamicReasons |
Arguments:
| Name |
Required |
Type |
Default |
| internalList |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
translates dynamic reason codes from cryptic-internal to human-readable |
| Description: |
|
|
|
| UPDATESTATICSTATUSDIALOG |
| function updateStaticStatusDialog |
Arguments:
| Name |
Required |
Type |
Default |
| message |
Required |
string |
|
| title |
Optional |
string |
[empty string] |
| bRefresh |
Optional |
numeric |
-1 |
| clearStatus |
Optional |
boolean |
no |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
updates structures used by static status dialog |
| Description: |
|
|
|
|
| subsite |
| struct |
| CHANGECOLLECTION |
| function ChangeCollection |
Arguments:
| Name |
Required |
Type |
Default |
| subsiteIDList |
Required |
String |
|
| verityName |
Required |
String |
|
| verityDir |
Required |
String |
|
| disableIndex |
Optional |
String |
-1 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Change subsite collection |
| Description: |
|
|
|
| CREATEDEFAULTFILES |
| function CreateDefaultFiles |
Arguments:
| Name |
Required |
Type |
Default |
| subsiteDir |
Required |
string |
|
| subsiteURL |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSCOPEFILTERIDLIST |
| function GetScopeFilterIDList |
Arguments:
| Name |
Required |
Type |
Default |
| scope |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the list of subsiteIDs to filter on, based on passed subsiteScope. |
| Description: |
|
|
|
|
| sync |
| struct |
| ADDLINE |
| function AddLine |
Arguments:
| Name |
Required |
Type |
Default |
| lineBuf |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CALLEDFROMREPLICATION |
| function CalledFromReplication |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| COMPAREFILESTRUCTURE |
| function CompareFileStructure |
Arguments:
| Name |
Required |
Type |
Default |
| structureMaster |
Required |
Struct |
|
| structureSlave |
Required |
Struct |
|
| timestamp |
Required |
String |
|
| dirInventory |
Required |
Struct |
|
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DBTOSTATEMENT |
| function DbToStatement |
Arguments:
| Name |
Required |
Type |
Default |
| srcFile |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FILETOSTATEMENT |
| function FileToStatement |
Arguments:
| Name |
Required |
Type |
Default |
| srcFile |
Optional |
Any |
|
| tmpFileDest |
Optional |
Any |
|
| isROOT |
Optional |
Any |
|
| deleted |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GENERATEARCHIVEFILENAME |
| function GenerateArchiveFilename |
Arguments:
| Name |
Required |
Type |
Default |
| ts |
Optional |
Any |
|
| localservername |
Optional |
Any |
|
| scopeId |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETREPLICATIONRECORDSTATUS |
| function GetReplicationRecordStatus |
Arguments:
| Name |
Required |
Type |
Default |
| slaveServerId |
Required |
numeric |
|
| destinationsitename |
Required |
string |
|
| scopeid |
Required |
numeric |
|
| serverip |
Required |
string |
|
| serverport |
Required |
numeric |
|
| lastupdate |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSYNCLOGFILENAME |
| function getSyncLogFilename |
Arguments:
| Name |
Required |
Type |
Default |
| sitename |
Optional |
String |
monitor |
| logType |
Optional |
String |
templog |
| extType |
Optional |
String |
txt |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INITIALIZELIST |
| function InitializeList |
Arguments:
| Name |
Required |
Type |
Default |
| buffer |
Optional |
Any |
|
| maxSize |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOGTOSTATEMENT |
| function LogToStatement |
Arguments:
| Name |
Required |
Type |
Default |
| msg |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| STATEMENTOBJECT |
| function StatementObject |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| STEPOBJECT |
| function StepObject |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SYNCSCHEDULEJOBS |
| function SyncScheduleJobs |
Arguments:
| Name |
Required |
Type |
Default |
| sitename |
Required |
String |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WRITECFHTTPERRORLOG |
| function WriteCFHttpErrorLog |
Arguments:
| Name |
Required |
Type |
Default |
| moduleName |
Required |
string |
|
| argurl |
Required |
string |
|
| filecontent |
Required |
string |
|
| sitename |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WRITESITELOG |
| function WriteSiteLog |
Arguments:
| Name |
Required |
Type |
Default |
| msg |
Required |
string |
|
| siteName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| tag |
| [cfc6] component
commonspot.udf.tag
|
| METHODS |
| ANYTAG |
| function anyTag |
Arguments:
| Name |
Required |
Type |
Default |
| tag |
Required |
string |
|
| skip |
Optional |
string |
[empty string] |
| selfClose |
Optional |
boolean |
true |
| escapeAttributes |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Generic tag renderer. Accepts any arguments, most of which are rendered as an attribute of the generated tag, with the exception of 'tag', 'skip' and 'selfClose', documented below. |
| Description: |
|
|
|
| CHECKBOXRADIO |
| function checkboxRadio |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
| value |
Optional |
string |
1 |
| checked |
Optional |
string |
false |
| label |
Optional |
string |
[empty string] |
| labelClass |
Optional |
string |
[empty string] |
| labelIsHTML |
Optional |
boolean |
false |
| escapeAttributes |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Generic renderer for html checkboxes and radio buttons. |
| Description: |
|
|
|
| CHECKBOXRADIOGROUP |
| function checkboxRadioGroup |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
| name |
Required |
string |
|
| values |
Required |
array |
|
| selectedValues |
Optional |
string |
[empty string] |
| delimiter |
Optional |
string |
= |
| separator |
Optional |
string |
<br/> |
| escapeAttributes |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Renders a set of html checkboxes or radios whose values and displayed texts come from passed array. Any arguments besides ones explictly declared here (plus type) are passed through to checkboxRadio. Each item is given a generated id, composed of the passed name with its numeric index in the group appended to the end. |
| Description: |
|
|
|
| ENDTAG |
| function endTag |
Arguments:
| Name |
Required |
Type |
Default |
| tag |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Generic close tag renderer. |
| Description: |
|
|
|
| ESCAPEORNOT |
| function escapeOrNot |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Required |
string |
|
| escape |
Optional |
boolean |
yes |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
HTML escapes passed string unless requested not to. |
| Description: |
|
|
|
| INPUT |
| function input |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Optional |
string |
text |
| value |
Optional |
string |
[empty string] |
| escapeAttributes |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Generic html input tag renderer. Use for all types of input elements except checkboxes and radio buttons. |
| Description: |
|
|
|
| NORMALIZESPACES |
| function normalizeSpaces |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Converts nbsp-space -> 2 spaces, undoing conversion done in toHTML. |
| Description: |
|
|
|
| OPTION |
| function option |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
| display |
Optional |
string |
[runtime expression] |
| selected |
Optional |
boolean |
false |
| escapeAttributes |
Optional |
boolean |
true |
| encodeContent |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Generic html select option renderer. |
| Description: |
|
|
|
| OPTIONSET |
| function optionSet |
Arguments:
| Name |
Required |
Type |
Default |
| values |
Required |
array |
|
| selectedValues |
Optional |
string |
[empty string] |
| includeBlankFirstItem |
Optional |
boolean |
false |
| delimiter |
Optional |
string |
= |
| escapeAttributes |
Optional |
boolean |
true |
| encodeContent |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Renders a set of html select options whose values and displayed texts come from passed array. |
| Description: |
|
|
|
| OPTIONSETFROMQUERY |
| function optionSetFromQuery |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
query |
|
| valuesCol |
Required |
string |
|
| displayCol |
Optional |
string |
[runtime expression] |
| selectedValues |
Optional |
string |
[empty string] |
| selectedValuesDelim |
Optional |
string |
, |
| includeBlankFirstItem |
Optional |
boolean |
false |
| escapeAttributes |
Optional |
boolean |
true |
| encodeContent |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Renders a set of html select options whose values and displayed texts come from a passed query. Takes a selectedValues argument, list of options values to select. |
| Description: |
|
|
|
| OPTIONSETFROMQUERY2 |
| function optionSetFromQuery2 |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
query |
|
| valuesCol |
Required |
string |
|
| selectedCol |
Required |
string |
|
| displayCol |
Optional |
string |
[runtime expression] |
| includeBlankFirstItem |
Optional |
boolean |
false |
| escapeAttributes |
Optional |
boolean |
true |
| encodeContent |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Renders a set of html select options whose values and displayed texts come from a passed query. Takes a selectedCol, query column with boolean values to select each option or not. |
| Description: |
|
|
|
| TAGPAIR |
| function tagPair |
Arguments:
| Name |
Required |
Type |
Default |
| tag |
Required |
string |
|
| content |
Optional |
string |
[empty string] |
| encodeContent |
Optional |
boolean |
true |
| skip |
Optional |
string |
[empty string] |
| escapeAttributes |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Generic renderer for a matched tag pair, with optional content between them. |
| Description: |
|
|
|
| TEXTAREA |
| function textarea |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
| escapeAttributes |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Generic html textarea renderer. |
| Description: |
|
|
|
|
|
| ui |
| struct |
| CHECKACTIONCOLUMN |
| function CheckActionColumn |
Arguments:
| Name |
Required |
Type |
Default |
| formID |
Optional |
numeric |
0 |
| action |
Optional |
String |
edit |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHOOSEICON |
| function ChooseIcon |
Arguments:
| Name |
Required |
Type |
Default |
| WIPInfo |
Required |
any |
|
| RenderMode |
Required |
String |
|
| VersionTimestamp |
Required |
String |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a structure containing an icon name and associated prompt text |
| Description: |
|
|
|
| DETERMINEICONCOLOR |
| function DetermineIconColor |
Arguments:
| Name |
Required |
Type |
Default |
| colorsList |
Required |
any |
|
| renderstate |
Optional |
any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the color of icon by applying the order of colors logic |
| Description: |
|
|
|
| RENDERCONTROLICON |
| function renderControlIcon |
Arguments:
| Name |
Required |
Type |
Default |
| Args |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RENDERCSUI |
| function RenderCSUI |
Arguments:
| Name |
Required |
Type |
Default |
| elementInfo |
Required |
any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the CSUI block for the current element |
| Description: |
|
|
|
| RENDERSIMPLEFORM |
| function RenderSimpleForm |
Arguments:
| Name |
Required |
Type |
Default |
| dataPageID |
Required |
numeric |
|
| formID |
Required |
numeric |
|
| postToNewWindow |
Required |
boolean |
|
| customizedFinalHtml |
Required |
Any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns html for Simple form fields. |
| Description: |
|
|
|
|
| upload |
| struct |
| UPDATEFILELOCATION |
| function updateFileLocation |
Arguments:
| Name |
Required |
Type |
Default |
| PageIDList |
Required |
string |
|
| privateFilename |
Optional |
string |
[empty string] |
| serverFilename |
Optional |
string |
[empty string] |
| FileOnly |
Optional |
any |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces utilities/upload/make-file-secure.cfm |
| Description: |
|
|
|
|
| util |
| struct |
| ADDTHUMBNAILURLTOQUERY |
| function addThumbnailURLToQuery |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
query |
|
| thumbnailFormat |
Required |
string |
|
| thumbnailURLColumn |
Optional |
string |
ThumbnailImageURL |
| idColumn |
Optional |
string |
ID |
| subsiteIDColumn |
Optional |
string |
SubsiteID |
| fileNameColumn |
Optional |
string |
FileName |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Adds thumbnail url to the query. |
| Description: |
|
|
|
| ADDUSERORGROUPNAMESTOQUERY |
| function addUserOrGroupNamesToQuery |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
query |
|
| idColumn |
Required |
string |
|
| nameColumn |
Required |
string |
|
| default |
Optional |
string |
[empty string] |
| zeroName |
Optional |
string |
Anonymous Users |
| nameSeparator |
Optional |
string |
, |
| negetiveOneName |
Optional |
string |
Current User |
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Adds a column to passed query w user or group names corresponding to values in query's idColumn. Returns passed default for IDs not found, passed zeroName for 0. query.idColumn values can be a comma-delimited list. |
| Description: |
|
|
|
| ARRAYTOTEXT |
| function arrayToText |
Arguments:
| Name |
Required |
Type |
Default |
| dumpArray |
Required |
any |
|
| level |
Optional |
numeric |
1 |
| limit |
Optional |
numeric |
0 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
log-friendly alternative to CFDump (for Arrays) |
| Description: |
|
|
|
| BUILDLOCALURL |
| function buildLocalURL |
Arguments:
| Name |
Required |
Type |
Default |
| SiteRootURL |
Required |
string |
|
| URL |
Required |
string |
|
| SiteID |
Optional |
numeric |
-1 |
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
manipulates the URL so it points to the correct site on the local server |
| Description: |
|
|
|
| BUILDSTUB |
| function BuildStub |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
| DataSource |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
builds requested stub |
| Description: |
|
|
|
| BUILDTHUMBNAIL |
| function buildThumbnail |
Arguments:
| Name |
Required |
Type |
Default |
| sourceFile |
Required |
string |
|
| targetDir |
Required |
string |
|
| height |
Required |
numeric |
|
| width |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
builds a thumbnail version of the given image |
| Description: |
|
|
|
| BUILDTHUMBNAILCOLLECTION |
| function buildThumbnailCollection |
Arguments:
| Name |
Required |
Type |
Default |
| sourceFile |
Required |
string |
|
| subsiteID |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
builds all specified thumbnail versions of the given image |
| Description: |
|
|
|
| CALLRENDERHANDLER |
| function CallRenderHandler |
Arguments:
| Name |
Required |
Type |
Default |
| Handler |
Required |
string |
|
| ElementInfo |
Required |
Struct |
|
| XMLTag |
Required |
string |
|
| XMLData |
Optional |
string |
[empty string] |
| XSLData |
Optional |
string |
[empty string] |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CAPITALIZESTRING |
| function capitalizeString |
Arguments:
| Name |
Required |
Type |
Default |
| initText |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Returns a string with words capitalized for a title |
| Description: |
|
|
|
| CFTHROW |
| function CFThrow |
Arguments:
| Name |
Required |
Type |
Default |
| message |
Required |
string |
|
| detail |
Optional |
string |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKINSTANCEOF |
| function checkInstanceOf |
Arguments:
| Name |
Required |
Type |
Default |
| reqObj |
Required |
any |
|
| reqType |
Required |
string |
|
| lang |
Required |
string |
java |
|
| ReturnType: |
Boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKLISTBYOPTIONVALUES |
| function checkListByOptionValues |
Arguments:
| Name |
Required |
Type |
Default |
| optionValues |
Optional |
Any |
|
| tempCurrentVal |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLEANURLFIELD |
| function CleanURLField |
Arguments:
| Name |
Required |
Type |
Default |
| field |
Optional |
Any |
|
| type |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CSDECRYPT |
| function CSDecrypt |
Arguments:
| Name |
Required |
Type |
Default |
| str1 |
Optional |
Any |
|
| key |
Optional |
Any |
|
| returnType |
Optional |
Any |
|
| method |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CSENCRYPT |
| function CSEncrypt |
Arguments:
| Name |
Required |
Type |
Default |
| str1 |
Optional |
Any |
|
| key |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CSFILEEXISTS |
| function CSFileExists |
Arguments:
| Name |
Required |
Type |
Default |
| fileName |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DASHBOARDCMDFATALERRORABORT |
| function dashboardCmdFatalErrorAbort |
Arguments:
| Name |
Required |
Type |
Default |
| code |
Required |
numeric |
|
| text |
Optional |
string |
[empty string] |
| data |
Optional |
struct |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Code that's not designed for use with dashboard commands but may be running in that context should call this when it can't continue (fatal errors, security exceptions, etc..). This function detects if a dashboard commmand is running, and if so, outputs appropriate dashboard command response xml, then aborts. Response is an array with one item, whose the Status structure consists of the passed args. |
| Description: |
|
|
|
| DECODESCHEDBROWSERFLAGS |
| function DecodeSchedBrowserFlags |
Arguments:
| Name |
Required |
Type |
Default |
| browserTypeString |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DESERIALIZE |
| function deserialize |
Arguments:
| Name |
Required |
Type |
Default |
| input |
Required |
String |
|
| throwOnError |
Optional |
boolean |
no |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DIRECTORYCOLLECTION |
| function directoryCollection |
Arguments:
| Name |
Required |
Type |
Default |
| dir |
Required |
string |
|
| filter |
Optional |
string |
[empty string] |
| mapType |
Optional |
string |
java.util.HashMap |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns a struct containing file nodes matching 'filter' in 'dir' |
| Description: |
|
|
|
| DUPLICATEBEAN |
| function duplicateBean |
Arguments:
| Name |
Required |
Type |
Default |
| bean |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FORMATCSDATE |
| function FormatCSDate |
Arguments:
| Name |
Required |
Type |
Default |
| date |
Required |
date |
|
| setMidNight |
Optional |
numeric |
0 |
| ingoreTime |
Optional |
boolean |
false |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a passed date as a string in CommonSpot's standard data storage format: YYYY-MM-DD HH:MM:SS |
| Description: |
|
|
|
| FORMATMILLISECONDS |
| function formatMilliseconds |
Arguments:
| Name |
Required |
Type |
Default |
| msCount |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
formats a millisecond count for readability |
| Description: |
|
|
|
| FORMATXML |
| function FormatXML |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETBEAN |
| function getBean |
Arguments:
| Name |
Required |
Type |
Default |
| beanName |
Required |
string |
|
| parentClass |
Optional |
string |
[empty string] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCHILDGROUPS |
| function getChildGroups |
Arguments:
| Name |
Required |
Type |
Default |
| groupIDList |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDTFORMATBYSTR |
| function getDTFormatByStr |
Arguments:
| Name |
Required |
Type |
Default |
| dt |
Required |
String |
|
| setMidNight |
Optional |
numeric |
0 |
| ingoreTime |
Optional |
boolean |
false |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETENCLOSUREINFO |
| function GetEnclosureInfo |
Arguments:
| Name |
Required |
Type |
Default |
| docType |
Required |
string |
|
| relativePath |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETENUMVALUESANDLABELS |
| function GetEnumValuesAndLabels |
Arguments:
| Name |
Required |
Type |
Default |
| validationType |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Returns a query of enum values and labels |
| Description: |
|
|
|
| GETGROUPMEMBERSHIPS |
| function getGroupMemberships |
Arguments:
| Name |
Required |
Type |
Default |
| userID |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns list of group IDs which the specified user is member of. |
| Description: |
|
|
|
| GETGROUPUSERS |
| function getGroupUsers |
Arguments:
| Name |
Required |
Type |
Default |
| groupIDList |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns list of users from a given group |
| Description: |
|
|
|
| GETHIGHESTUNITS |
| function getHighestUnits |
Arguments:
| Name |
Required |
Type |
Default |
| seconds |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
reduces the given number of seconds to the highest-possible units (minutes/hours/days) with a whole-number value |
| Description: |
|
|
|
| GETNEWCONTROLID |
| function getNewControlID |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| elementTypeID |
Required |
numeric |
|
| parentControlID |
Required |
numeric |
|
| parentControlTypeID |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns an ID for a new element and creates a ControlInstance record for it |
| Description: |
|
|
|
| GETNODATAMODULESDIR |
| function getNoDataModulesDir |
Arguments:
| Name |
Required |
Type |
Default |
| mode |
Optional |
string |
directory |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns the path to the standard no data handlers directory for the current site. If arguments.mode=module, returns url path, otherwise returns directory path. |
| Description: |
|
|
|
| GETUNIQUECLONENAMEWITHPARAMS |
| function GetUniqueCloneNameWithParams |
Arguments:
| Name |
Required |
Type |
Default |
| originalName |
Required |
string |
|
| dsName |
Required |
string |
|
| tableName |
Required |
string |
|
| columnName |
Required |
string |
|
| filterCriteria |
Optional |
string |
[empty string] |
| maxLength |
Optional |
numeric |
0 |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a unique clone name for the spcified original name and specified params. |
| Description: |
|
|
|
| GETUNIQUECLONENAMEWITHQUERY |
| function GetUniqueCloneNameWithQuery |
Arguments:
| Name |
Required |
Type |
Default |
| originalName |
Required |
string |
|
| query |
Required |
query |
|
| columnName |
Required |
string |
|
| filterCriteria |
Optional |
string |
[empty string] |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a unique clone name for the spcified original name and specified query. |
| Description: |
|
|
|
| GETUSERANDGROUPNAMES |
| function getUserAndGroupNames |
Arguments:
| Name |
Required |
Type |
Default |
| idList |
Required |
string |
|
| zeroName |
Optional |
string |
Anonymous Users |
| negetiveOneName |
Optional |
string |
Current user |
| format |
Optional |
numeric |
2 |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Returns a struct with user or group name for each ID in passed idList. Returns empty string for IDs not found, passed zeroName for 0. |
| Description: |
|
|
|
| GETUSERDETAILSFOREMAIL |
| function getUserDetailsForEmail |
Arguments:
| Name |
Required |
Type |
Default |
| userGroupID |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns user email address, formatted name |
| Description: |
|
|
|
| ISOFTYPE |
| function IsOfType |
Arguments:
| Name |
Required |
Type |
Default |
| object |
Required |
any |
|
| type |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns true if the given value is a valid instance of the specified type |
| Description: |
|
|
|
| LISTFINDANYINLIST |
| function ListFindAnyInList |
Arguments:
| Name |
Required |
Type |
Default |
| list1 |
Required |
string |
|
| list2 |
Required |
string |
|
| delim |
Optional |
string |
, |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
determine if list1 and list2 have any common elements |
| Description: |
|
|
|
| LISTFINDANYINLISTNOCASE |
| function ListFindAnyInListNoCase |
Arguments:
| Name |
Required |
Type |
Default |
| list1 |
Required |
string |
|
| list2 |
Required |
string |
|
| delim |
Optional |
string |
, |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
case-insensitive variant of ListFindAnyInList |
| Description: |
|
|
|
| LISTSYMMETRICDIFFERENCE |
| function listSymmetricDifference |
Arguments:
| Name |
Required |
Type |
Default |
| listA |
Required |
string |
|
| listB |
Required |
string |
|
| listType |
Optional |
string |
numeric |
| delimiter |
Optional |
string |
, |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the sorted list representing the (set) 'symmetric difference' of 'listA' and 'listB' |
| Description: |
|
|
|
| LISTTRIMITEMS |
| function listTrimItems |
Arguments:
| Name |
Required |
Type |
Default |
| list |
Required |
string |
|
| delimiters |
Optional |
string |
, |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns passed list with each of its items separately trimmed. |
| Description: |
|
|
|
| LISTTRUNCATE |
| function ListTruncate |
Arguments:
| Name |
Required |
Type |
Default |
| inList |
Required |
string |
|
| newLength |
Required |
numeric |
|
| delimiter |
Optional |
string |
, |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Truncates a list to have no more than the requested number of items |
| Description: |
|
|
|
| MAKEPRESERVEOBJ |
| function makePreserveObj |
Arguments:
| Name |
Required |
Type |
Default |
| keyList |
Required |
String |
|
| excludeKeyList |
Optional |
String |
[empty string] |
| keyToQofQ |
Optional |
boolean |
true |
| returnObj |
Optional |
String |
List |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAKEUNIQUEARRAY |
| function makeUniqueArray |
Arguments:
| Name |
Required |
Type |
Default |
| inArray |
Required |
Array |
|
| sortType |
Optional |
string |
none |
| sortOrder |
Optional |
string |
asc |
|
| ReturnType: |
Array
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the given Array with any duplicates removed. Array is sorted if a sortType is given |
| Description: |
|
|
|
| MAKEUNIQUELIST |
| function makeUniqueList |
Arguments:
| Name |
Required |
Type |
Default |
| inList |
Required |
string |
|
| sortType |
Optional |
string |
none |
| sortOrder |
Optional |
string |
asc |
| listDelim |
Optional |
string |
, |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the given list with any duplicates removed. List is sorted if a sortType is given |
| Description: |
|
|
|
| NORMALIZEDIRECTORYPATH |
| function normalizeDirectoryPath |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
| wantTrailingSlash |
Optional |
boolean |
yes |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
normalizes given path so all slashes are forward slashes... and so the path always ends with a single slash |
| Description: |
|
|
|
| NORMALIZEFILENAME |
| function normalizeFilename |
Arguments:
| Name |
Required |
Type |
Default |
| sourceString |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces ct-prepare-string-forfile.cfm |
| Description: |
|
|
|
| NORMALIZETOTYPE |
| function normalizeToType |
Arguments:
| Name |
Required |
Type |
Default |
| value |
Required |
string |
|
| typeName |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns passed value as normalized to requested cs type |
| Description: |
|
|
|
| POPULATESTRUCT |
| function populateStruct |
Arguments:
| Name |
Required |
Type |
Default |
| keyList |
Required |
String |
|
| excludeKeyList |
Optional |
String |
[empty string] |
| defaultValue |
Optional |
any |
[empty string] |
| keyToQofQ |
Optional |
boolean |
no |
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PREPARECSMODULE |
| function prepareCSModule |
Arguments:
| Name |
Required |
Type |
Default |
| csModule |
Required |
string |
|
| doCleanup |
Optional |
string |
yes |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
prepares the csModule value passed as request.param value before passing it to the loader for a cfinclude |
| Description: |
|
|
|
| RESOLVEIMAGEURL |
| function resolveImageURL |
Arguments:
| Name |
Required |
Type |
Default |
| ImageID |
Required |
string |
|
| ImageAltText |
Optional |
string |
[empty string] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RESOLVEUPLOADEDDOCURL |
| function resolveUploadedDocURL |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
|
| ReturnType: |
STRING
|
| Roles: |
|
| Access: |
PUBLIC |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
Returns the URL to an uploaded document. If readable by anonymous users, returns its public url, otherwise returns its getfile url |
|
|
| SCHEDULELOCALJOB |
| function ScheduleLocalJob |
Arguments:
| Name |
Required |
Type |
Default |
| Action |
Required |
string |
|
| URL |
Required |
string |
|
| Task |
Required |
string |
|
| Interval |
Optional |
string |
once |
| Publish |
Optional |
boolean |
yes |
| Path |
Optional |
string |
[runtime expression] |
| File |
Optional |
string |
[empty string] |
| StartDate |
Optional |
string |
[empty string] |
| StartTime |
Optional |
string |
[empty string] |
| RequestTimeout |
Optional |
numeric |
7200 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Constructs a CFSchedule call appropriate for a local (on current server) request |
| Description: |
|
|
|
| SERIALIZEBEAN |
| function serializeBean |
Arguments:
| Name |
Required |
Type |
Default |
| bean |
Required |
any |
|
| tagName |
Optional |
string |
[empty string] |
| forceLCase |
Optional |
boolean |
false |
| catchExceptions |
Optional |
boolean |
true |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SORTEDDIRECTORYARRAY |
| function sortedDirectoryArray |
Arguments:
| Name |
Required |
Type |
Default |
| dir |
Required |
string |
|
| filter |
Optional |
string |
[empty string] |
|
| ReturnType: |
array
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
replaces sorted-directory-array.cfm |
| Description: |
|
|
|
| STACKTRACETOTEXT |
| function stackTraceToText |
Arguments:
| Name |
Required |
Type |
Default |
| trace |
Required |
any |
|
| level |
Optional |
numeric |
1 |
| limit |
Optional |
numeric |
0 |
| fullDumpLevels |
Optional |
numeric |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
log-friendly alternative to CFDump (for stack trace) |
| Description: |
|
|
|
| STARTUPFATALERRORABORT |
| function startupFatalErrorAbort |
Arguments:
| Name |
Required |
Type |
Default |
| errorMsg |
Required |
string |
|
| catchinfo |
Optional |
any |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
This function detects any fatal error in Start up process, if a dashboard commmand is running, show message in lightbox |
| Description: |
|
|
|
| STRUCTTOTEXT |
| function structToText |
Arguments:
| Name |
Required |
Type |
Default |
| struct |
Required |
any |
|
| name |
Optional |
string |
(unknown name) |
| isCFCatch |
Optional |
boolean |
false |
| wantFullTrace |
Optional |
boolean |
false |
| level |
Optional |
numeric |
1 |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
log-friendly alternative to CFDump (for Structures) |
| Description: |
|
|
|
| THROWCSEXCEPTION |
| function ThrowCSException |
Arguments:
| Name |
Required |
Type |
Default |
| errorType |
Required |
string |
|
| reason |
Optional |
string |
[empty string] |
| closeDialogRequired |
Optional |
boolean |
0 |
| cause |
Optional |
any |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| TIMEVALUETOSECONDS |
| function timeValueToSeconds |
Arguments:
| Name |
Required |
Type |
Default |
| intValue |
Required |
numeric |
|
| units |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
converts a number/units combination into a number of seconds |
| Description: |
|
|
|
| TRANSLATEENUMVALUE |
| function TranslateEnumValue |
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
query |
|
| inputField |
Required |
string |
|
| outputField |
Required |
string |
|
| enumType |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
translates a DB value into the given enum's 'display' equivalent |
| Description: |
|
|
|
| TYPEDCACHECLEANUP |
| function typedCacheCleanup |
Arguments:
| Name |
Required |
Type |
Default |
| DSN |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
clears orphan records from TypedCacheInstances and TypedCacheHits |
| Description: |
|
|
|
| UNIQUELISTAPPEND |
| function UniqueListAppend |
Arguments:
| Name |
Required |
Type |
Default |
| list |
Required |
string |
|
| value |
Required |
string |
|
| delimiter |
Optional |
string |
, |
| caseSensitive |
Optional |
boolean |
yes |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
Builds a list with unique values |
| Description: |
|
|
|
| UPDATESTUBSTATUS |
| function UpdateStubStatus |
Arguments:
| Name |
Required |
Type |
Default |
| PageID |
Required |
numeric |
|
| UpdateTimestamp |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
notification method for use when authoring server updates stub file in shared-filesystem environment |
| Description: |
|
|
|
| VALIDATEEXPLICITMODULE |
| function validateExplicitModule |
Arguments:
| Name |
Required |
Type |
Default |
| file |
Required |
string |
|
| type |
Required |
string |
code |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| VERIFYNUMERICFIELDS |
| function VerifyNumericFields |
Arguments:
| Name |
Required |
Type |
Default |
| inStruct |
Required |
struct |
|
| fieldList |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
For the given structure, ensures that the listed fields are defined AND numeric |
| Description: |
|
|
|
| WAITSECS |
| function waitSecs |
Arguments:
| Name |
Required |
Type |
Default |
| secs |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Delays code execution for the requested number of seconds. |
| Description: |
|
|
|
| WDDXDECODE |
| function WDDXDecode |
Arguments:
| Name |
Required |
Type |
Default |
| Input |
Required |
String |
|
| WantRethrow |
Optional |
Numeric |
0 |
| LogError |
Optional |
Numeric |
1 |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WDDXENCODE |
| function WDDXEncode |
Arguments:
| Name |
Required |
Type |
Default |
| Input |
Required |
Any |
|
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| xmlpub |
| struct |
| CHECKITEMFIELDNAME |
| function CheckItemFieldName |
Arguments:
| Name |
Required |
Type |
Default |
| pubDefID |
Required |
numeric |
|
| itemFieldID |
Required |
numeric |
|
| itemFieldName |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEXMLPUBLICATIONCACHE |
| function DeleteXMLPublicationCache |
Arguments:
| Name |
Required |
Type |
Default |
| IDs |
Required |
string |
|
| XMLPublicationFormatID |
Optional |
numeric |
0 |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FORMATFEEDURL |
| function FormatFeedURL |
Arguments:
| Name |
Required |
Type |
Default |
| qry |
Required |
query |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Output: |
no |
| DisplayName: |
|
| Hint: |
format feed url |
| Description: |
|
|
|
| GETAVAILABLEFIELDSFORBINDING |
| function GetAvailableFieldsForBinding |
Arguments:
| Name |
Required |
Type |
Default |
| controlTypeID |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETAVAILCONTROLSFORADMIN |
| function GetAvailControlsForAdmin |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETAVAILCONTROLSFORXMLPUBLICATION |
| function GetAvailControlsForXMLPublication |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETELEMENTPUBLICATIONS |
| function GetElementPublications |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| controlID |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETELEMENTXSL |
| function GetElementXSL |
Arguments:
| Name |
Required |
Type |
Default |
| pubDefName |
Required |
string |
|
| controlID |
Required |
numeric |
|
| metadataFieldNames |
Required |
string |
|
| itemFieldNames |
Required |
string |
|
| itemFieldValues |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFEEDFORMATINFO |
| function GetFeedFormatInfo |
Arguments:
| Name |
Required |
Type |
Default |
| xmlPublicationID |
Required |
numeric |
|
| pagename |
Required |
String |
|
| subsiteURL |
Required |
String |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETRESOLVEDFEEDURL |
| function GetResolvedFeedURL |
Arguments:
| Name |
Required |
Type |
Default |
| subSiteURL |
Required |
String |
|
| filename |
Required |
String |
|
| feedname |
Required |
String |
|
| feedformat |
Required |
String |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETXMLPUBLICATIONBYBINDING |
| function GetXMLPublicationByBinding |
Arguments:
| Name |
Required |
Type |
Default |
| IDs |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETXMLPUBLICATIONLIST |
| function GetXMLPublicationList |
Arguments:
| Name |
Required |
Type |
Default |
| pageID |
Required |
numeric |
|
| controlID |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INVALIDATEFEEDINDEXCACHE |
| function InvalidateFeedIndexCache |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RENDERXMLPUBLICATION |
| function RenderXMLPublication |
Arguments:
| Name |
Required |
Type |
Default |
| ElementInfo |
Required |
Struct |
|
| XMLTag |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEELEMENTXSL |
| function UpdateElementXSL |
Arguments:
| Name |
Required |
Type |
Default |
| pubDefID |
Required |
numeric |
|
| isNewMetadataField |
Optional |
boolean |
no |
| newMetadataFieldName |
Optional |
String |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
| xmltools |
| struct |
| BUILDFORMATTEDDATESTRUCT |
| function BuildFormattedDateStruct |
Arguments:
| Name |
Required |
Type |
Default |
| Timestamp |
Required |
string |
|
| dtFormat |
Optional |
string |
[runtime expression] |
| tmFormat |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| BUILDFORMATTEDUSERSTRUCT |
| function BuildFormattedUserStruct |
Arguments:
| Name |
Required |
Type |
Default |
| UserID |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| BUILDRESOLVEDURL |
| function BuildResolvedURL |
Arguments:
| Name |
Required |
Type |
Default |
| URL |
Required |
string |
|
| pageID |
Optional |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| ValidationFlags |
1
|
|
| coldfusion |
| struct |
| InstallKit |
Native Windows
|
| appserver |
JRun4
|
| expiration |
{ts '2012-05-01 00:59:13'}
|
| productlevel |
Enterprise
|
| productname |
ColdFusion Server
|
| productversion |
9,0,1,274733
|
| rootdir |
C:\ColdFusion9
|
| supportedlocales |
Chinese (China),Chinese (Hong Kong),Chinese (Taiwan),Dutch (Belgian),Dutch (Standard),English (Australian),English (Canadian),English (New Zealand),English (UK),English (US),French (Belgian),French (Canadian),French (Standard),French (Swiss),German (Austrian),German (Standard),German (Swiss),Italian (Standard),Italian (Swiss),Japanese,Korean,Norwegian (Bokmal),Norwegian (Nynorsk),Portuguese (Brazilian),Portuguese (Standard),Spanish (Mexican),Spanish (Modern),Spanish (Standard),Swedish,ar,ar_AE,ar_BH,ar_DZ,ar_EG,ar_IQ,ar_JO,ar_KW,ar_LB,ar_LY,ar_MA,ar_OM,ar_QA,ar_SA,ar_SD,ar_SY,ar_TN,ar_YE,be,be_BY,bg,bg_BG,ca,ca_ES,cs,cs_CZ,da,da_DK,de,de_AT,de_CH,de_DE,de_LU,el,el_CY,el_GR,en,en_AU,en_CA,en_GB,en_IE,en_IN,en_MT,en_NZ,en_PH,en_SG,en_US,en_ZA,es,es_AR,es_BO,es_CL,es_CO,es_CR,es_DO,es_EC,es_ES,es_GT,es_HN,es_MX,es_NI,es_PA,es_PE,es_PR,es_PY,es_SV,es_US,es_UY,es_VE,et,et_EE,fi,fi_FI,fr,fr_BE,fr_CA,fr_CH,fr_FR,fr_LU,ga,ga_IE,hi_IN,hr,hr_HR,hu,hu_HU,in,in_ID,is,is_IS,it,it_CH,it_IT,iw,iw_IL,ja,ja_JP,ja_JP_JP,ko,ko_KR,lt,lt_LT,lv,lv_LV,mk,mk_MK,ms,ms_MY,mt,mt_MT,nl,nl_BE,nl_NL,no,no_NO,no_NO_NY,pl,pl_PL,pt,pt_BR,pt_PT,ro,ro_RO,ru,ru_RU,sk,sk_SK,sl,sl_SI,sq,sq_AL,sr,sr_BA,sr_CS,sr_ME,sr_RS,sv,sv_SE,th,th_TH,th_TH_TH,tr,tr_TR,uk,uk_UA,vi,vi_VN,zh,zh_CN,zh_HK,zh_SG,zh_TW
|
|