class sap.ui.generic.app.transaction.BaseController

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/generic/app/transaction/BaseController
Application Component: CA-UI5-ST

Common base class for sap.ui.generic.app.transaction.TransactionController and sap.ui.generic.app.transaction.DraftController, which offers basic functionality to invoke OData functions and actions as well as OData CRUD functions in general.


Constructor

Constructor for base class for controller instances.

new sap.ui.generic.app.transaction.BaseController(oModel, oQueue)
Param Type Default Value Description
oModel sap.ui.model.odata.ODataModel

The OData model currently used

oQueue sap.ui.generic.app.util.Queue

Optional HTTP request queue


Methods Overview

Method Description
attachFatalError

Attaches event handler fnFunction to the fatalError event.

destroy

Frees all resources claimed during the life-time of this instance.

detachFatalError

Detaches event handler fnFunction from the fatalError event.

sap.ui.generic.app.transaction.BaseController.extend

Creates a new subclass of class sap.ui.generic.app.transaction.BaseController with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.EventProvider.extend.

sap.ui.generic.app.transaction.BaseController.getMetadata

Returns a metadata object for class sap.ui.generic.app.transaction.BaseController.

hasClientMessages

Checks for client messages.

triggerSubmitChanges

Triggers submitting the currently tracked changes to the back-end.

updateMultipleEntities

Update multiple entities

attachFatalError

Attaches event handler fnFunction to the fatalError event.

Param Type DefaultValue Description
fnFunction function

The function to call when the event occurs

oListener object

Object on which to call the given function

destroy

Frees all resources claimed during the life-time of this instance.

detachFatalError

Detaches event handler fnFunction from the fatalError event.

Param Type DefaultValue Description
fnFunction function

The function to call when the event occurs

oListener object

Object on which to call the given function

sap.ui.generic.app.transaction.BaseController.extend

Creates a new subclass of class sap.ui.generic.app.transaction.BaseController with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.EventProvider.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.ui.generic.app.transaction.BaseController.getMetadata

Returns a metadata object for class sap.ui.generic.app.transaction.BaseController.

hasClientMessages

Checks for client messages.

triggerSubmitChanges

Triggers submitting the currently tracked changes to the back-end.

Param Type DefaultValue Description
mParameters Object<string,any>

Parameters to control the submit behavior

noBlockUI boolean

If set to true, the current user interface is not blocked by a busy animation

noShowResponse boolean

If set to true, no success and error messages are shown

noShowSuccessToast boolean

If set to true, the success message is not shown in a toast

successMsg string

An optional success message

failedMsg string

An optional error message

updateMultipleEntities

Update multiple entities

Param Type DefaultValue Description
context array

path and data to be updated