fourq

fourq

fourq

Metadata

Instantiating

AfterSave()

Called from setData and createData and run after the object has been saved.

Arguments

Name Type Required Default Options Description
stProperties struct Yes A structure containing the contents of the properties that were saved to the object.

createData()

Create an object including array properties. Pass in a structure of property values; arrays should be passed as an array. The objectID can be ommitted and one will be created, passed in as an argument or passed in as a key of stProperties argument.

Arguments

Name Type Required Default Options Description
stProperties struct Yes
objectid UUID No [runtime expression]
dsn string No [runtime expression]
dbtype string No [runtime expression]
dbowner string No [runtime expression]

deleteData()

Delete the specified objectid and corresponding data, including array properties and refObjects.

Arguments

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

deployType()

Arguments

Name Type Required Default Options Description
bDropTable boolean No false

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]

getData()

Get data for a specific objectid and return as a structure, including array properties and typename.

Arguments

Name Type Required Default Options Description
objectid uuid Yes
dsn string No [runtime expression]
bShallow boolean No false Setting to true filters all longchar property types from record.
bFullArrayProps boolean No true Setting to true returns array properties as an array of structs instead of an array of strings IF IT IS AN EXTENDED ARRAY.
bUseInstanceCache boolean No true setting to use instance cache if one exists
bArraysAsStructs boolean No false Setting to true returns array properties as an array of structs instead of an array of strings.

getDefaultObject()

Arguments

Name Type Required Default Options Description
ObjectID UUID No
typename string Yes [runtime expression]

getI18Fieldset()

Provides access to I18 values for labels etc

Arguments

Name Type Required Default Options Description
step any No The step being queried
fieldset any Yes 0 The fieldset being queried
value string No label The value required i.e. label, helptitle, helpsection

getI18Property()

Provides access to I18 values for properties

Arguments

Name Type Required Default Options Description
property string Yes The property being queried
value string No label The value required i.e. label, helptitle, helpsection

getI18Step()

Provides access to I18 values for labels etc

Arguments

Name Type Required Default Options Description
step any Yes The step being queried
value string No label The value required i.e. label, helptitle, helpsection

getNavID()

Returns the default Navigation objectID for the objectID passed in. Empty if it cant find anything applicable.

Arguments

Name Type Required Default Options Description
objectid string No The objectid for which the navigation objectid is to be found.
typename string No The typename of the object for which the navigation objectid is to be found.

getTypeName()

Arguments

Name Type Required Default Options Description
None

getTypePath()

Arguments

Name Type Required Default Options Description
None

getView()

Returns the HTML of a view from the webskin content type folder.

Arguments

Name Type Required Default Options Description
objectid string No ObjectID of the object that is to be rendered by the webskin view.
template string No Name of the template in the corresponding content type webskin folder, without the .cfm extension.
webskin string No Name of the template in the corresponding content type webskin folder, without the .cfm extension.
stparam struct No [runtime expression] Structure of parameters to be passed into the display handler.
stobject struct No Property structure to render in view. Overrides any property structure mapped to arguments.objectid. Useful if you want to render a view with a modified content item.
dsn string No [runtime expression]
onExitProcess any No A url string to redirect to if a processForm exit='true' is called within the webskin
alternateHTML string No If the webskin template does not exist, if this argument is sent in, its value will be passed back as the result.
hashKey string No Pass in a key to be used to hash the objectBroker webskin cache
bAjax boolean No 0 Flag to determine whether to render an ajax call to load the webskin instead of inline.
ajaxID string No The id to give the div that will call the ajaxed webskin
ajaxShowloadIndicator boolean No false Should the ajax loading indicator be shown
ajaxindicatorText string No loading... What should be text of the loading indicator
ajaxURLParameters string No parameters to pass for ajax call
ajaxTimeout numeric No 30 ajax timeout
bIgnoreSecurity boolean No false Should the getView() ignore webskin security
bAllowTrace boolean No true Sometimes having webskin trace information can break the integrity of a page. This allows you to turn it off.

initMetaData()

Extract all component metadata in a flat format for loading into a shared scope.

Arguments

Name Type Required Default Options Description
stMetaData struct No [runtime expression] Structure to which this cfc's parameters are appended

isDeployed()

Returns True if the table is already deployed

Arguments

Name Type Required Default Options Description
None

mergeWebskins()

Merge webskin result queries, skipping duplicates. Non destructive.

Arguments

Name Type Required Default Options Description
query1 query Yes
query2 query Yes

paramMetaData()

Set up default values for missing meta data attributes. Non destructive.

Arguments

Name Type Required Default Options Description
stProps struct Yes
lAttributes string Yes
default string No

runView()

Calls the current view and returns the generated content. Used by getView on types, forms and rules.

Arguments

Name Type Required Default Options Description
stobj String Yes
webskinTypename String Yes
webskinTemplate String Yes
webskinPath String Yes
webskinCacheID String Yes
hashKey String Yes
stparam struct No [runtime expression] Structure of parameters to be passed into the display handler.
onExitProcess any No A url string to redirect to if a processForm exit='true' is called within the webskin
dsn string No [runtime expression]
bAllowTrace boolean No true Sometimes having webskin trace information can break the integrity of a page. This allows you to turn it off.

setData()

Update the record for an objectID including array properties. Pass in a structure of property values; arrays should be passed as an array.

Arguments

Name Type Required Default Options Description
stProperties String Yes
dsn string No [runtime expression]
bSessionOnly string No false
bSetDefaultCoreProperties boolean No true This allows the developer to skip defaulting the core properties if they dont exist.