objectBroker

objectBroker

addCSSHeadToWebskins()

Adds the result of a skin:loadCSS to all relevent webskin caches

Arguments

NameTypeRequiredDefaultOptionsDescription
stCSSstructYes

addhtmlHeadToWebskins()

Adds the result of a skin:htmlHead to all relevent webskin caches

Arguments

NameTypeRequiredDefaultOptionsDescription
idstringNo#application.fc.utils.createJavaUUID()#
textstringNo
librarystringNo
libraryStatebooleanNotrue
onReadystringNo

addJSHeadToWebskins()

Adds the result of a skin:loadJS to all relevent webskin caches

Arguments

NameTypeRequiredDefaultOptionsDescription
stJSstructYes

AddToObjectBroker()

Arguments

NameTypeRequiredDefaultOptionsDescription
stObjstructYes
typenamestringYes

addWebskin()

Adds webskin to object broker if all conditions are met

Arguments

NameTypeRequiredDefaultOptionsDescription
ObjectIDUUIDNo
typenamestringYes
templatestringYes
webskinCacheIDstringYes
HTMLstringYes
stCurrentViewstructYes

CleanupObjectBroker()

Removes 10% of the items in the object broker if it is full.

Arguments

NameTypeRequiredDefaultOptionsDescription
typenamestringYes

configureType()

Arguments

NameTypeRequiredDefaultOptionsDescription
typenamestringYes
MaxObjectsnumericNo100
MaxWebskinsnumericNo10

flushTypeWatchWebskins()

Finds all webskins watching this type for any CRUD functions and flushes them from the cache

Arguments

NameTypeRequiredDefaultOptionsDescription
objectIDstringNoThe typename that the CRUD function was performed on.
typenamestringNo
stObjectstringNoAlternative to objectID+typename

generateWebskinCacheID()

Generates a webskin Cache ID that can be hashed to store a specific version of a webskin cache.

Arguments

NameTypeRequiredDefaultOptionsDescription
typenamestringYes
templatestringYes
hashKeystringNo
bCacheByURLstringNo#application.coapi.coapiadmin.getWebskincacheByURL(typename=arguments.typename, template=arguments.template)#
bCacheByFormstringNo#application.coapi.coapiadmin.getWebskincacheByForm(typename=arguments.typename, template=arguments.template)#
bCacheByRolesstringNo#application.coapi.coapiadmin.getWebskincacheByRoles(typename=arguments.typename, template=arguments.template)#
lcacheByVarsstringNo#application.coapi.coapiadmin.getWebskincacheByVars(typename=arguments.typename, template=arguments.template)#

GetFromObjectBroker()

Arguments

NameTypeRequiredDefaultOptionsDescription
ObjectIDUUIDYes
typenamestringYes

GetObjectCacheEntry()

Get an object's cache entry in the object broker

Arguments

NameTypeRequiredDefaultOptionsDescription
ObjectIDUUIDYes
typenamestringYes

getWebskin()

Searches the object broker in an attempt to locate the requested webskin template. Returns a struct containing the webskinCacheID and the html.

Arguments

NameTypeRequiredDefaultOptionsDescription
ObjectIDUUIDNo
typenamestringYes
templatestringYes
hashKeystringYes

init()

Arguments

NameTypeRequiredDefaultOptionsDescription
bFlushbooleanNofalseAllows the application to force a total flush of the objectbroker.

putObjectCacheEntry()

Arguments

NameTypeRequiredDefaultOptionsDescription
stCacheEntrystructYes
objectidUUIDYes
typenamestringYes

reapDeadEntriesFromBroker()

Cleans out soft references to recycled objects in the object broker.

Arguments

RemoveFromObjectBroker()

Arguments

NameTypeRequiredDefaultOptionsDescription
None
NameTypeRequiredDefaultOptionsDescription
lObjectIDsstringYes
typenamestringYes
eventNamestringNoflushName of event that triggered the removal {flush,reap,evict}

removeWebskin()

Searches the object broker in an attempt to locate the requested webskin template

Arguments

NameTypeRequiredDefaultOptionsDescription
ObjectIDUUIDNo
typenamestringYes
templatestringYes

trackObjectEvent()

Arguments

NameTypeRequiredDefaultOptionsDescription
eventnamestringYes
typenamestringYes
objectidstringYes