class sap.ui.support.ExecutionScope

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Extends:
Module: sap/ui/support/supportRules/ExecutionScope
Application Component:

Allows to select the scope of analysis on an application.

Overview

ExecutionScope is the third parameter of a rule check function. It provides access to internal UI5 objects available for inspection. The getElements API method allows the user to select a specific subset of elements valid for their case. It accepts one query object argument.

Usage

When a rule is executed, three parameters are passed: oIssueManager, oCoreFacade and oScope.

An ExecutionScope instance is passed to every call of a rule check function. When you analyze your application, available objects are collected depending on the settings passed to the Support Assistant at the moment when you start it.


Constructor

new sap.ui.support.ExecutionScope()

Methods Overview

Method Description
sap.ui.support.ExecutionScope.getElements
sap.ui.support.ExecutionScope.getElementsByClassName

Gets elements by their type

sap.ui.support.ExecutionScope.getLoggedObjects

Gets the logged objects by object type

sap.ui.support.ExecutionScope.getPublicElements

Returns all public elements, i.e. elements that are part of public API aggregations

sap.ui.support.ExecutionScope.getType

Gets the type of the execution scope

sap.ui.support.ExecutionScope.getElements

Param Type DefaultValue Description
oConfig object

Object with specific filtering options

type string

Type name to filter by type

public boolean

Option to exclude elements that are not public aggregations

cloned boolean

Option to exclude elements that are clones of list bindings

sap.ui.support.ExecutionScope.getElementsByClassName

Gets elements by their type

Param Type DefaultValue Description
classNameSelector string function

Either string or function to be used when selecting a subset of elements

sap.ui.support.ExecutionScope.getLoggedObjects

Gets the logged objects by object type

Param Type DefaultValue Description
type any

Type of logged objects

sap.ui.support.ExecutionScope.getPublicElements

Returns all public elements, i.e. elements that are part of public API aggregations

sap.ui.support.ExecutionScope.getType

Gets the type of the execution scope