Creation of URIs for fetching a query dimension value set.
Create a request object for interaction with a dimension value help. Such a value help is served by either the query result entity set, in which case the returned dimension members are limited to those also used in the query result data. Or, the value help is populated by a master data entity set, if made available by the service. In this case, the result will include all valid members for that dimension.
new sap.ui.model.analytics.odata4analytics.DimensionMemberSetRequest(oDimension, oParameterizationRequest, bUseMasterData)
Param | Type | Default Value | Description |
---|---|---|---|
oDimension | sap.ui.model.analytics.odata4analytics.Dimension | Description of a dimension |
|
oParameterizationRequest | sap.ui.model.analytics.odata4analytics.ParameterizationRequest | (optional) Request object for interactions with the parameterization of the query result or (not yet supported) master data entity set Such an object is required if the entity set holding the dimension members includes parameters. |
|
bUseMasterData | boolean | (optional) Indicates use of master data for determining the dimension members. |
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. |
getResultPageBoundaries |
Returns the current page boundaries as object with properties |
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. |
getURIToDimensionMemberEntitySet |
Get the URI to locate the entity set for the dimension memebers. |
getURIToDimensionMemberEntries |
Get the unescaped URI to fetch the dimension members, optionally augmented by text and attributes. |
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. |
setParameterizationRequest |
Set the parameterization request required for retrieving dimension members directly from the query result, if it is parameterized. |
setRequestOptions |
Set further options to be applied for the OData request |
setResultPageBoundaries |
Specify that only a page of the query result shall be returned. A page is described by its boundaries, that are row numbers for the first and last rows in the query result to be returned. |
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. |
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 the current page boundaries as object with properties start
and end
. If the end of the page is unbounded, end
is null.
Get the sort expression for this request.
Expressions are represented by separate objects. If none exists so far, a new expression object gets created.
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 |
Get the URI to locate the entity set for the dimension memebers.
Param | Type | DefaultValue | Description |
---|---|---|---|
sServiceRootURI | string |
(optional) Identifies the root of the OData service |
Get the unescaped URI to fetch the dimension members, optionally augmented by text and attributes.
Param | Type | DefaultValue | Description |
---|---|---|---|
sServiceRootURI | string |
(optional) Identifies the root of the OData service |
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. |
Set the parameterization request required for retrieving dimension members directly from the query result, if it is parameterized.
Param | Type | DefaultValue | Description |
---|---|---|---|
oParameterizationRequest | undefined |
Request object for interactions with the parameterization of this query result |
Set further options to be applied for the OData request
Param | Type | DefaultValue | Description |
---|---|---|---|
bIncludeCount | boolean |
Indicates whether or not the result shall include a count for the returned entities. Default is not to include it. Pass null to keep current setting. |
Specify that only a page of the query result shall be returned. A page is described by its boundaries, that are row numbers for the first and last rows in the query result to be returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
start | int |
The first row of the query result to be returned. Numbering starts at 1. Passing null is equivalent to start with the first row. |
|
end | int |
The last row of the query result to be returned. Passing null is equivalent to get all rows up to the end of the query result. |
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. |