com.sap.ip.bi.sdk.dac.olap.query
Interface IBIVarFactory

All Known Subinterfaces:

IBIAllFactory

public interface IBIVarFactory

Factory for the variable values of a query. The factory can be retrieved from the IBIQueryFactory, which itself can be retrieved from IBIOlap.

Since:

3.50 SP2

Method Summary

IBISapHierarchyValue	createSapHierarchyValue(Hierarchy hierarchy) Creates an IBISapHierarchyValue and initializes it with the specified parameters.
IBISapMemberValueRange	createSapMemberValue(IBISapRangeSignType sapRangeSignType, IBIRelationalOperatorType relationalOperatorType, IBIMember member) Creates an IBISapMemberValueRange and initializes it with the specified parameters.
IBISapMemberValueRange	createSapMemberValueRange(IBISapRangeSignType sapRangeSignType, IBIMember memberLow, IBIMember memberHigh) Creates an IBISapMemberValueRange and initializes the member range with the specified parameters.
IBISapNumericValueRange	createSapNumericValue(IBISapRangeSignType sapRangeSignType, IBIRelationalOperatorType relationalOperatorType, IBIAnyDataValue value) Creates an IBISapNumericValueRange and initializes it with the specified parameters.
IBISapNumericValueRange	createSapNumericValueRange(IBISapRangeSignType sapRangeSignType, IBIAnyDataValue valueLow, IBIAnyDataValue valueHigh) Creates an IBISapNumericValueRange and initializes the numeric value range with the specified parameters.

Method Detail

createSapMemberValue

public IBISapMemberValueRange createSapMemberValue(IBISapRangeSignType sapRangeSignType,
                                                   IBIRelationalOperatorType relationalOperatorType,
                                                   IBIMember member)
                                            throws BIOlapQueryException

Creates an IBISapMemberValueRange and initializes it with the specified parameters.

Parameters:

sapRangeSignType - the range sign type with which to initialize the created object

relationalOperatorType - the operator type with which to initialize the created object

member - the member with which to initialize the object created

Returns:

the IBISapMemberValueRange created

Throws:

BIOlapQueryException - if null parameters are passed

createSapMemberValueRange

public IBISapMemberValueRange createSapMemberValueRange(IBISapRangeSignType sapRangeSignType,
                                                        IBIMember memberLow,
                                                        IBIMember memberHigh)
                                                 throws BIOlapQueryException

Creates an IBISapMemberValueRange and initializes the member range with the specified parameters.

Parameters:

sapRangeSignType - the range sign type with which to initialize the created object

memberLow - the low limit of the specified member range

memberHigh - the high limit of the specified member range

Returns:

the IBISapMemberValueRange created

Throws:

BIOlapQueryException - if null parameters are passed

createSapHierarchyValue

public IBISapHierarchyValue createSapHierarchyValue(Hierarchy hierarchy)
                                             throws BIOlapQueryException

Creates an IBISapHierarchyValue and initializes it with the specified parameters.

Parameters:

hierarchy - the hierarchy represented by the IBISapHierarchyValue

Returns:

the IBISapHierarchyValue created

Throws:

BIOlapQueryException - if the hierarchy is null

createSapNumericValue

public IBISapNumericValueRange createSapNumericValue(IBISapRangeSignType sapRangeSignType,
                                                     IBIRelationalOperatorType relationalOperatorType,
                                                     IBIAnyDataValue value)
                                              throws BIOlapQueryException

Creates an IBISapNumericValueRange and initializes it with the specified parameters.

Parameters:

sapRangeSignType - the range sign type with which to initialize the created object

relationalOperatorType - the operator type with which to initialize the created object

value - the value with which to initialize the created object

Returns:

the IBISapNumericValueRange created

Throws:

BIOlapQueryException - if null parameters are passed

createSapNumericValueRange

public IBISapNumericValueRange createSapNumericValueRange(IBISapRangeSignType sapRangeSignType,
                                                          IBIAnyDataValue valueLow,
                                                          IBIAnyDataValue valueHigh)
                                                   throws BIOlapQueryException

Creates an IBISapNumericValueRange and initializes the numeric value range with the specified parameters.

Parameters:

sapRangeSignType - the range sign type with which to initialize the created object

valueLow - the low value of the specified range

valueHigh - the high value of the specified range

Returns:

the created IBISapNumericValueRange

Throws:

BIOlapQueryException - if null parameters are passed