udb function object

Previous Next

The object structure of the USoft DB Library has a global entry point for data source information. The library can be reached by the following statement:

$.udb

This establishes the library as a jQuery-like plug-in, since the $ sign identifies the jQuery library and offers access to it.

Objects and functions

The udb function object exposes the following objects and functions.

NOTE: In addition to the functions listed in the table below, the udb object equally exposes all the functions listed for the udbMeta object.

Object or function

Description

udb()

Function to get a data source with a given name.

.acceptLookupValue()

Function that accepts the selected lookup value on the lookup page or dialog.

.applyCurrentContext()

Function that applies a context to a settle function of a Promise object.

.cancelWindow()

Function that rejects the lookup value and close the lookup page or dialog.

.checkData()

Function to check the data of the current record.

.checkLoginRequired()

Function that checks if the current login is still valid.

.checkVersion()

Function to check the USoft version.

.clearGenericHostVars()

Function to clear generic host variables.

.closePage()

Function to close the page and return to the previous page on the stack.

.commit()

Function to commit manipulated data.

.currentPageName()

Function that gives the name of the current page.

.currentPageNavigationSource()

Function that gives the navigation action name that caused the current page to be displayed (for example: closePage, navigateTo).

.currentPageStackDepth()

Function that returns the stack depth of the current page; if it returns a value higher than 1, this usually indicates that a Related Page or a Lookup Page is displayed.

.executeSQLStatement()

Function to execute a statement.

.genericHostVar()

Function to assign a value to a generic host variable.

.getMenu()

Function to fetch a menu.

.groupRequests()

Function to group a set of requests and send them as one request.

.hostvars

Object used to store temporary (one-time use) host variables.

isCommitted()

Function to check for uncommitted manipulations, i.e. manipulations that have not committed to the database.

.isTransactionChecked()

Function to check for unchecked manipulations

.login()

Function to login.

.logout()

Function to logout.

.mainPageName()

Function that gives the name of the page at the start of the page navigation stack.

.navigateTo()

Function to navigate to another page.

.navigateToLookup()

Function to navigate to a lookup page.

.navigateToRelated()

Function to navigate to a related page.

.off()

Function to remove a handler from an event.

.on()

Function that binds a handler to an event.

.ping()

Function that sends a single to the server to notify that the connection must be kept alive.

.rollback()

Function to rollback manipulated data.

.setTimeout()

Function to set a timeout event for when the application is idle (no user activity).

.settings

Collection of functions that give access to USoft web application settings and flags.

.showLogin()

Function to show the login page.

.status.loggedIn()

Function showing whether the user is currently logged in.

.status.logonRequired()

Function showing whether the current page requires logon.

.trigger()

Function to trigger an event.

.upload()

Function to handle a file upload operation.