Class sap.ui.model.analytics.odata4analytics.ParameterModule: sap/ui/model/analytics/odata4analytics


Representation of a property annotated with sap:parameter.

Constructor Summary
new sap.ui.model.analytics.odata4analytics.Parameter(oParameterization, oProperty)Create a representation of a single parameter contained in a parameterization.
Method Summary
getContainingParameterization()Get parameterization containing this parameter
getLabelText()Get label
getName()Get the name of the parameter
getPeerIntervalBoundaryParameter()Get property for the parameter representing the peer boundary of the same interval
getProperty()Get property
getTextProperty()Get text property related to this parameter
getURIToValueEntitySet(sServiceRootURI)Get the URI to locate the entity set holding the value set, if it is available.
isIntervalBoundary()Get indicator if the parameter represents an interval boundary
isLowerIntervalBoundary()Get indicator if the parameter represents the lower boundary of an interval
isOptional()Get indicator whether or not the parameter is optional
isValueSetAvailable()Get indicator if a set of values is available for this parameter.
Constructor Detail
new sap.ui.model.analytics.odata4analytics.Parameter(oParameterization, oProperty)
Create a representation of a single parameter contained in a parameterization. Do not create your own instances.
Parameters:
{sap.ui.model.analytics.odata4analytics.Parameterization}oParameterization The parameterization containing this parameter
{object}oProperty The DataJS object object representing the text property
Method Detail
Get parameterization containing this parameter
Returns:
{sap.ui.model.analytics.odata4analytics.Parameterization} The parameterization object
getLabelText(): string
Get label
Returns:
{string} The (possibly language-dependent) label text for this parameter
getName(): string
Get the name of the parameter
Returns:
{string} The name of the parameter, which is identical with the name of the property representing the parameter in the parameterization entity type
getPeerIntervalBoundaryParameter(): sap.ui.model.analytics.odata4analytics.Parameter
Get property for the parameter representing the peer boundary of the same interval
Returns:
{sap.ui.model.analytics.odata4analytics.Parameter} The parameter representing the peer boundary of the same interval. This means that if *this* parameter is a lower boundary, the returned object
getProperty(): object
Get property
Returns:
{object} The DataJS object representing the property of this parameter
getTextProperty(): object
Get text property related to this parameter
Returns:
{object} The DataJS object representing the text property or null if it does not exist
getURIToValueEntitySet(sServiceRootURI)
Get the URI to locate the entity set holding the value set, if it is available.
Parameters:
{String}sServiceRootURI (optional) Identifies the root of the OData service
isIntervalBoundary(): boolean
Get indicator if the parameter represents an interval boundary
Returns:
{boolean} True iff it represents an interval boundary, otherwise false
isLowerIntervalBoundary(): boolean
Get indicator if the parameter represents the lower boundary of an interval
Returns:
{boolean} True iff it represents the lower boundary of an interval, otherwise false
isOptional(): boolean
Get indicator whether or not the parameter is optional
Returns:
{boolean} True iff the parameter is optional
isValueSetAvailable(): boolean
Get indicator if a set of values is available for this parameter. Typically, this is true for parameters with a finite set of known values such as products, business partners in different roles, organization units, and false for integer or date parameters
Returns:
{boolean} True iff a value set is available, otherwise false