base.cfc

CFIDE.adminapi.base
Component base (base)

Base object for other Admin API CFCs.

hierarchy:	WEB-INF.cftags.component CFIDE.adminapi.base
path:	{web-root}\CFIDE\adminapi\base.cfc
serializable:	Yes
properties:
methods:	dump, getEdition, getInstallType, getJRunRootDir, isAdminUser, RDSInvoker, setJrunSN, tfformat, throw

* – private method

dump
`public dump ( required value, expand="true" )` Used to debug variables inside of cfscript. Output: enabled Parameters: value: any, required, value – ColdFusion variable or scope to display. expand: any, optional, expand – Expand views, yes or no (Internet Explorer and Mozilla only).
getEdition
`package string getEdition (` `)` Returns the edition: Developer Evaluation Standard Enterprise Professional Output: suppressed
getInstallType
`package string getInstallType (` `)` Returns the install type. Output: suppressed
getJRunRootDir
`string getJRunRootDir (` `)` Output:
isAdminUser
`public isAdminUser ( requiredRoles="" )` Check to see if user is authenticated Output: suppressed Parameters: requiredRoles: any, optional, requiredRoles – List of required roles.
RDSInvoker
`public RDSInvoker ( required service, required method, required args, required adminPassword, required adminUserId )` Used internally to invoke the Administrator API from Dreamweaver. Output: suppressed Parameters: service: any, required, service – Name of service. method: any, required, method – Name of method to invoke. args: any, required, args – Arguments for remote method. adminPassword: any, required, adminPassword – RDS password for authentication adminUserId: any, required, adminUserId – Administrative user id for authentication
setJrunSN
`package void setJrunSN ( required serialNum )` Utility function that sets the JRun OEM serial number. Output: suppressed Parameters: serialNum: any, required, serialNum
tfformat*
`private tfformat ( required val )` Indicates whether a passed value is of data type Boolean. Output: suppressed Parameters: val: any, required, val – Value to be checked.
throw*
`private throw ( message="", type="Exception" )` Used to throw errors in a cfscript block. Output: suppressed Parameters: message: any, optional, message – A message that describes the error. type: any, optional, type

Leave a Reply Cancel reply