Namespace: lifecycle

bcdui.core. lifecycle

This namespace contains functions related to BCD-UI page lifecycle management.

Classes

AutoRefresh

Methods

staticbcdui.core.lifecycle.applyAction(args)

core/lifecycle/lifecyclePackage.js, line 124
Takes the current guiStatus and re-invokes the current page with it /guiStatus:Status/guiStatus:ClientSettings is removed as it only serves for temporary information
Name Type Description
args Object
Name Type Default Description
cleanXPath boolean optional Additional XPath to be cleaned from the guiStatus
validateFilters boolean false optional True or false whether or not to check IsValid flags of guiStatus filters
statusDocument DomDocument bcdui.wkModels.guiStatus optional optionally, other statusDocument than guiStatus
removeAllParams boolean false optional True or false whether or not to remove all url parameters first

staticbcdui.core.lifecycle.bookmarkAction(args)

core/lifecycle/lifecyclePackage.js, line 183
Creates a bookmark entry for the current page + guiStatus
Name Type Description
args Object
Name Type Default Description
proposedName Object document.title optional Name of the bookmark
cleanClientSettings Object true optional True or false whether or not to clean /guiStatus:Status/guiStatus:ClientSettings from the $guiStatus
cleanXPath Object optional Additional XPath to be cleaned from the guiStatus, useful for removing current period filter for example

staticbcdui.core.lifecycle.jumpTo(href, statusDocument)

core/lifecycle/lifecyclePackage.js, line 160
Jumps to another url optionally setting status document, this function is executed asynchronously.
Name Type Description
href url target URL to jump to.
statusDocument DomDocument optional status document to pass as guiStatusGZ parameter to href.