SAP BI Java SDK

com.sap.ip.bi.sdk.dac.olap.query.var
Interface IBISapVariable

All Superinterfaces:
Attribute, Element, Feature, IBIIdentifiable, ModelElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, StructuralFeature
All Known Subinterfaces:
IBISapHierarchyVariable, IBISapMemberVariable, IBISapNumericVariable

public interface IBISapVariable
extends Attribute, IBIIdentifiable

Abstract supertype for the three different types of SAP variables. These variables are:

In SAP BW, variables are a means of parameterizing queries, and we refer to them here as SAP variables. Since these variables can be used in BW's Open Analysis Interfaces, they therefore are supported in the BI Java SDK by using various BW-specific enhancements to the MDX syntax.

For an example of working with SAP variables in the SDK, see Olap_10.java on the Examples page.

For more information about SAP variables, see the SAP Help Portal documentation on SAP Variables.


Method Summary
 IBISapVariableSelectionType getSelectionType()
           Specifies selection types.
 boolean isInitialSupported()
           Specifies whether the initial value is supported.
 boolean isMandatory()
           Specifies whether specifying a variable value is mandatory.
 
Methods inherited from interface org.omg.cwm.objectmodel.core.Attribute
getInitialValue, setInitialValue
 
Methods inherited from interface org.omg.cwm.objectmodel.core.StructuralFeature
getChangeability, getMultiplicity, getOrdering, getTargetScope, getType, setChangeability, setMultiplicity, setOrdering, setTargetScope, setType
 
Methods inherited from interface org.omg.cwm.objectmodel.core.Feature
getOwner, getOwnerScope, setOwner, setOwnerScope
 
Methods inherited from interface org.omg.cwm.objectmodel.core.ModelElement
getClientDependency, getConstraint, getImporter, getName, getNamespace, getVisibility, setName, setNamespace, setVisibility
 
Methods inherited from interface javax.jmi.reflect.RefObject
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite
 
Methods inherited from interface javax.jmi.reflect.RefFeatured
refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue
 
Methods inherited from interface javax.jmi.reflect.RefBaseObject
equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints
 
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.main.IBIIdentifiable
getDescription, getId, getLabel, setDescription, setId, setLabel
 

Method Detail

getSelectionType

public IBISapVariableSelectionType getSelectionType()
                                             throws javax.jmi.reflect.JmiException

Specifies selection types. Each variable has a value or a number of values assigned to it, and these values are specified by selection types. The selection type specifies what kind of variable value is expected. This can be a single value, an interval or a complex selection specification. There are three kinds of selection types:

To more completely describe complex value selection and its component single value and interval selection types, we illustrate an example in the graphic below:

complex value selection

The value illustrated above can be described verbally as:

The rule for calculating complex value selection is as follows:


isInitialSupported

public boolean isInitialSupported()
                           throws javax.jmi.reflect.JmiException

Specifies whether the initial value is supported. This depends on the VARIABLE_ENTRY_TYPE of the SAP variable, which can be one of the following three values:


isMandatory

public boolean isMandatory()
                    throws javax.jmi.reflect.JmiException

Specifies whether specifying a variable value is mandatory. This depends on the VARIABLE_ENTRY_TYPE of the SAP variable, which can be one of the following three values:


SAP BI Java SDK

Copyright © 2004-2006 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.