odata4analytics

Creation of URIs for fetching a query parameter value set.

Constructor Summary

new sap.ui.model.analytics.odata4analytics.ParameterValueSetRequest(oParameter)Create a request object for interaction with a query parameter value help.

Method Summary

getFilterExpression()Get the filter expression for this request.

getSortExpression()Get the sort expression for this request.

getURIQueryOptionValue(sQueryOptionName)Get the value of an query option for the OData request URI corresponding to this request.

getURIToParameterValueSetEntries(sServiceRootURI)Get the unescaped URI to fetch the parameter value set.

includeParameterText(bIncludeText)Specify which components of the parameter shall be included in the value set.

setFilterExpression(oFilter)Set the filter expression for this request.

setSortExpression(oSorter)Set the sort expression for this request.

Constructor Detail

new sap.ui.model.analytics.odata4analytics.ParameterValueSetRequest(oParameter)

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

Parameters:

{sap.ui.model.analytics.odata4analytics.Parameter}

oParameter

Description of a query parameter

Method Detail

getFilterExpression(): sap.ui.model.analytics.odata4analytics.FilterExpression

Get the filter expression for this request.

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

Returns:

{sap.ui.model.analytics.odata4analytics.FilterExpression}

The filter object associated to this request.

getSortExpression(): sap.ui.model.analytics.odata4analytics.SortExpression

Get the sort expression for this request.

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

Returns:

{sap.ui.model.analytics.odata4analytics.SortExpression}

The sort object associated to this request.

getURIQueryOptionValue(sQueryOptionName): String

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

Parameters:

{String}

sQueryOptionName

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

Returns:

{String}

The value of the requested query option or null, if this option is not used for the OData request.

getURIToParameterValueSetEntries(sServiceRootURI): String

Get the unescaped URI to fetch the parameter value set.

Parameters:

{String}

sServiceRootURI

(optional) Identifies the root of the OData service

Returns:

{String}

The unescaped URI that contains the OData resource path and OData system query options to express the request for the parameter value set..

includeParameterText(bIncludeText)

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

Parameters:

bIncludeText

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

setFilterExpression(oFilter)

Set the filter expression for this request.

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

Parameters:

{sap.ui.model.analytics.odata4analytics.FilterExpression}

oFilter

The filter object to be associated with this request.

setSortExpression(oSorter)

Set the sort expression for this request.

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

Parameters:

{sap.ui.model.analytics.odata4analytics.SortExpression}

oSorter

The sort object to be associated with this request.