com.businessobjects.datasource
Interface PreConditionObject

All Superinterfaces:
DataSourceObject

public interface PreConditionObject
extends DataSourceObject

Provides a representation of a precondition object in the universe. You can use a precondition object in a query condition.

The DataSourceSpecification for a universe contains zero or more DataSourceClass instances. Each of these DataSourceClass instances contains zero or more instances of objects that inherit from the DataSourceObject interface. Essentially, this means that the DataSourceClass instances in a given DataSourceSpecification contain Detail, Dimension, Measure and PreConditionObject instances that can be used to construct a query.

See DataSourceObject for information about how to find PreConditionObject instances in a DataSourceSpecification.

Once you have obtained the keys for the PreConditionObject instances in a DataSourceSpecification you then add the keys for the objects that you want to include in your query condition to PreCondition instances. See PreCondition for details about how to include a PreConditionObject object in a query condition.

Note: The QuerySpecification interface is the root interface for a query. It contains CombinedQuery instances which, in turn, contain Query instances (which then contain QueryObject and QueryCondition instances). The QueryCondition interface is used to create a query condition.

See Also:
DataSourceObject, DataSourceSpecification, PreCondition, QueryCondition

Nested Class Summary
static class PreConditionObject.Factory
          A class with methods for creating instances of the PreConditionObject type.
 
Field Summary
static org.apache.xmlbeans.SchemaType type
          Internal Use Only.
 
Method Summary
 ObjectType.Enum getType()
           Gets the type of the PreConditionObject instance as an ObjectType.
 void setType(ObjectType.Enum type)
          Internal Use Only.
 ObjectType xgetType()
          Internal Use Only.
 void xsetType(ObjectType type)
          Internal Use Only.
 
Methods inherited from interface com.businessobjects.datasource.DataSourceObject
getAllowedInFilter, getAllowedInResult, getAllowedInSort, getDescription, getHasDelegatedLov, getKey, getName, setAllowedInFilter, setAllowedInResult, setAllowedInSort, setDescription, setHasDelegatedLov, setKey, setName, xgetAllowedInFilter, xgetAllowedInResult, xgetAllowedInSort, xgetDescription, xgetHasDelegatedLov, xgetKey, xgetName, xsetAllowedInFilter, xsetAllowedInResult, xsetAllowedInSort, xsetDescription, xsetHasDelegatedLov, xsetKey, xsetName
 

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getType

ObjectType.Enum getType()

Gets the type of the PreConditionObject instance as an ObjectType.

Returns:
the type of the PreConditionObject instance as an ObjectType.

xgetType

ObjectType xgetType()

Internal Use Only.


setType

void setType(ObjectType.Enum type)

Internal Use Only.


xsetType

void xsetType(ObjectType type)

Internal Use Only.