com.businessobjects.query
Interface ConditionBase

All Known Subinterfaces:
Filter, PreCondition, QueryCondition, Rank, SubQuery

public interface ConditionBase

Provides the parent interface for the query condition sub-interfaces, PreCondition, Rank, SubQuery, Filter, and QueryCondition.

A QueryCondition instance contains an array of ConditionBase instances. This allows you to use the sub-interfaces of this interface to add query conditions to the query. For example, to add a filter condition to the query, you would create a Filter instance, and then add it to the ConditionBase array in the QueryCondition instance. Furthermore, if you want to add additional query conditions to the query, you can add a QueryCondition instance to the ConditionBase array.

Example: Creating a custom query condition.

Note: This example assumes that you have created a QueryObject array called boQueryResultObjects that contains query result object keys from the Universe.

        QuerySpecification boQuerySpec = QuerySpecification.Factory.newInstance();
        Query boQuery1 = Query.Factory.newInstance();
        QueryCondition boQueryCondition = QueryCondition.Factory.newInstance();
        Filter boCondFilter = Filter.Factory.newInstance();
        QueryObject boQueryConditionObject = QueryObject.Factory.newInstance();
        boQueryConditionObject.setKey((String)dimensionKeys.get(0));
        boCondFilter.setFilteredObject(boQueryConditionObject);
        boCondFilter.setFilterOperator(FilterOperator.EQUAL);
        Operand[] boConditionValues = new Operand[1];
        Values boFreeValues = Values.Factory.newInstance();
        String[] boConditionValueString = new String[] {"France"};
        boFreeValues.setFreeValueArray(boConditionValueString);
        boConditionValues[0] = boFreeValues;
        boCondFilter.setOperandArray(boConditionValues);
        ConditionBase[] boConditionBase = new ConditionBase[1];
        boConditionBase[0] = boCondFilter;
        boQueryCondition.setItemArray(boConditionBase);
        boQuery1.setQueryCondition(boQueryCondition);
        boQuery1.setQueryResultArray(boQueryResultObjects);
        boQuerySpec.setQueryBase(boQuery1);
 

See Also:
QueryCondition, PreCondition, PreConditionObject

Nested Class Summary
static class ConditionBase.Factory
          A class with methods for creating instances of the ConditionBase type.
 
Field Summary
static org.apache.xmlbeans.SchemaType type
          Internal Use Only.
 
Method Summary
 java.lang.String getID()
           Gets the ID for this ConditionBase instance.
 boolean isSetID()
          Checks if ConditionBase has an ID attribute.
 void setID(java.lang.String id)
          Internal Use Only.
 void unsetID()
          Internal Use Only.
 org.apache.xmlbeans.XmlString xgetID()
          Internal Use Only.
 void xsetID(org.apache.xmlbeans.XmlString id)
          Internal Use Only.
 

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getID

java.lang.String getID()

Gets the ID for this ConditionBase instance.

Returns:
The ID for this ConditionBase instance

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.


isSetID

boolean isSetID()
Checks if ConditionBase has an ID attribute.

Returns:
true if the ID of the ConditionBase is set, otherwise false

setID

void setID(java.lang.String id)

Internal Use Only.


xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.


unsetID

void unsetID()

Internal Use Only.