coapiadmin

coapiadmin

coapiadmin

Metadata

Location 
application.coapi.coapiadmin

findType()

Determine the typename for an objectID.

Arguments

Name Type Required Default Options Description
objectid String Yes
dsn string No [runtime expression]
dbowner string No [runtime expression]

getBrowserCacheTimeOut()

Returns the objectbroker timeout value of a webskin. A result of 0 will FORCE any ancestor webskins to NEVER cache. The default value is the objectBrokerWebskinCacheTimeout value set in the type cfc which defaults to 1400 minutes

Arguments

Name Type Required Default Options Description
typename string Yes
template string Yes
path string No
defaultTimeOut numeric No -1

getCOAPIComponents()

Get query of COAPI components by package directory.

Arguments

Name Type Required Default Options Description
project string Yes
package string Yes
plugins string No

getExtendedTypeArray()

Initialise component.

Arguments

Name Type Required Default Options Description
packagePath String Yes

getFormtoolDefaults()

Returns the default value of metadata applicable to a formtool passed in. Omitting the md name, defaults for all metadata for the formtool will be returned.

Arguments

Name Type Required Default Options Description
formtool string Yes The formtool containing the property

getincludeAuthor()

Arguments

Name Type Required Default Options Description
template string Yes
directory string Yes

getincludeDescription()

', templateCode)>

Arguments

Name Type Required Default Options Description
template string Yes
directory string Yes

getIncludeDisplayname()

Arguments

Name Type Required Default Options Description
template string Yes
directory string Yes

getIncludePath()

Returns the cfmapping path to an include. Search through project first, then any library's that have been included.

Arguments

Name Type Required Default Options Description
template string Yes
directory string Yes

getIncludes()

Returns a query of all available included objects. Search through project first, then any library's that have been included.

Arguments

Name Type Required Default Options Description
None

getPluginInstallers()

Get query of library install files. Install files limitd to CFM includes.

Arguments

Name Type Required Default Options Description
plugins string Yes List of farcry libraries to process.

getProxyCacheTimeOut()

Returns the objectbroker timeout value of a webskin. A result of 0 will FORCE any ancestor webskins to NEVER cache. The default value is the objectBrokerWebskinCacheTimeout value set in the type cfc which defaults to 1400 minutes

Arguments

Name Type Required Default Options Description
typename string Yes
template string Yes
path string No
defaultTimeOut numeric No -1

getWebskin()

Returns the webskins struct for a webskin specified by methodname

Arguments

Name Type Required Default Options Description
typename string Yes
webskin string Yes methodname

getWebskinAuthor()

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinCacheByForm()

Returns the objectbroker cacheByForm boolean value of a webskin. A result of true will HASH all simple form scope variables on all ancestor webskins in the cache.

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinCacheByRoles()

Returns the objectbroker cacheByRoles boolean value of a webskin. A result of true will HASH the session.security.roles on all ancestor webskins in the cache.

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinCacheByURL()

Returns the objectbroker cacheByURL boolean value of a webskin. A result of true will HASH the cgi.QUERY_STRING on all ancestor webskins in the cache.

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinCacheByVars()

Returns the objectbroker cacheByVars list of a webskin. The list of session vars will HASH the values of those vars on all ancestor webskins in the cache.

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinCacheFlushOnFormPost()

Returns the objectbroker cacheFlushOnFormPost boolean value of a webskin. A result of true will HASH all simple form scope variables on all ancestor webskins in the cache.

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinCacheFlushOnObjectChange()

Returns the objectbroker cacheFlushOnObjectChange value of a webskin. If true, the ancestry of this webskin will be captured and will be flushed if any crud methods on its object is fired.

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinCacheStatus()

Returns the objectbroker cache status of a webskin. Status can be -1:force ancestors to not cache, 0:do not cache, 1:cache

Arguments

Name Type Required Default Options Description
typename string Yes
template string Yes
path string No
defaultStatus numeric No 0

getWebskinCacheTimeOut()

Returns the objectbroker timeout value of a webskin. A result of 0 will FORCE any ancestor webskins to NEVER cache. The default value is the objectBrokerWebskinCacheTimeout value set in the type cfc which defaults to 1400 minutes

Arguments

Name Type Required Default Options Description
typename string Yes
template string Yes
path string No
defaultTimeOut numeric No [runtime expression]

getWebskinCacheTypeWatch()

Returns the objectbroker cacheTypeWatch list of a webskin. The list of typenames will be watched for crud methods on any of its objects and if so, will flush all instances of the webskin for that types listed here.

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinDescription()

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinDisplayname()

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No

getWebskinPath()

Returns the path to a webskin. Search through project first, then any library's that have been included.

Arguments

Name Type Required Default Options Description
typename string Yes
template string Yes

getWebskins()

Returns a query of all available webskins. Search through project first, then any library's that have been included.

Arguments

Name Type Required Default Options Description
typename string No [runtime expression] Typename of instance.
prefix string No Prefix to filter template results.
bForceRefresh boolean No false Force to reload and not use application scope.
excludeWebskins string No Allows developers to exclude webskins that might be contained in plugins.
packagePath string No The path to the type.
aExtends array No The components this type extends
viewBinding string No
viewStack string No

init()

Initialise component.

Arguments

Name Type Required Default Options Description
None

initializeIncludes()

Returns a query of all available included objects. Search through project first, then any library's that have been included.

Arguments

Name Type Required Default Options Description
None

parseWebskinMetadata()

Returns a struct of the metadata for all requested property metadata in a webskin

Arguments

Name Type Required Default Options Description
typename string No
template string No
path string No
lProperties string Yes
lTypes string No
lDefaults string No

setupProjectDirectorys()

sets up a query containing ALL webskins available to the project

Arguments

Name Type Required Default Options Description
None