class sap.ui.model.analytics.odata4analytics.ParameterValueSetRequest

UX Guidelines:
Implements:
Available since: N/A
Extends:
Module: sap/ui/model/analytics/odata4analytics
Application Component: CA-UI5-COR

Creation of URIs for fetching a query parameter value set.


Constructor

Create a request object for interaction with a query parameter value help.

new sap.ui.model.analytics.odata4analytics.ParameterValueSetRequest(oParameter)
Param Type Default Value Description
oParameter sap.ui.model.analytics.odata4analytics.Parameter

Description of a query parameter


Methods Overview

Method Description
getFilterExpression

Get the filter expression for this request.

Expressions are represented by separate objects. If none exists so far, a new expression object gets created.

getSortExpression

Get the sort expression for this request.

Expressions are represented by separate objects. If none exists so far, a new expression object gets created.

getURIQueryOptionValue

Get the value of a query option for the OData request URI corresponding to this request.

getURIToParameterValueSetEntries

Get the unescaped URI to fetch the parameter value set.

includeParameterText

Specify which components of the parameter shall be included in the value set.

setFilterExpression

Set the filter expression for this request.

Expressions are represented by separate objects. Calling this method replaces the filter object maintained by this request.

setSortExpression

Set the sort expression for this request.

Expressions are represented by separate objects. Calling this method replaces the sort object maintained by this request.

getFilterExpression

Get the filter expression for this request.

Expressions are represented by separate objects. If none exists so far, a new expression object gets created.

getSortExpression

Get the sort expression for this request.

Expressions are represented by separate objects. If none exists so far, a new expression object gets created.

getURIQueryOptionValue

Get the value of a query option for the OData request URI corresponding to this request.

Param Type DefaultValue Description
sQueryOptionName string

Identifies the query option: $select, $filter,... or any custom query option

getURIToParameterValueSetEntries

Get the unescaped URI to fetch the parameter value set.

Param Type DefaultValue Description
sServiceRootURI string

(optional) Identifies the root of the OData service

includeParameterText

Specify which components of the parameter shall be included in the value set.

Param Type DefaultValue Description
bIncludeText boolean

Indicator whether or not to include the parameter text (if available) in the value set. Pass null to keep current setting.

setFilterExpression

Set the filter expression for this request.

Expressions are represented by separate objects. Calling this method replaces the filter object maintained by this request.

Param Type DefaultValue Description
oFilter sap.ui.model.analytics.odata4analytics.FilterExpression

The filter object to be associated with this request.

setSortExpression

Set the sort expression for this request.

Expressions are represented by separate objects. Calling this method replaces the sort object maintained by this request.

Param Type DefaultValue Description
oSorter sap.ui.model.analytics.odata4analytics.SortExpression

The sort object to be associated with this request.