com.businessobjects.query
Interface PreCondition

All Superinterfaces:

ConditionBase

public interface PreCondition
extends ConditionBase

The PreCondition interface represents a PreConditionObject object in a query condition. To add an existing query precondition to a query, obtain a PreConditionObject object from the Universe and then set the key of a PreCondition instance to the key of the PreConditionObject.

Example: Constructing a query with a PreConditionObject

Note: It is assumed that you have obtained a query condition objects in the Universe (data source) and have stored their keys in a list called preConditionObjectKeys. See DataSourceObject for information about how to obtain PreConditionObject instances in a DataSourceSpecification.

 QuerySpecification boQuerySpec = QuerySpecification.Factory.newInstance();
 Query boQuery1 = Query.Factory.newInstance();
 QueryCondition boQueryCondition = QueryCondition.Factory.newInstance();
 ConditionBase[] boConditionBase = new ConditionBase[1];
 PreCondition boPreCondition = PreCondition.Factory.newInstance();
 boPreCondition.setKey((String)preConditionObjectKeys.get(0));
 boConditionBase[0] = boPreCondition;
 boQueryCondition.setItemArray(boConditionBase);
 boQuery1.setQueryCondition(boQueryCondition);
 boQuery1.setQueryResultArray(boQueryResultObjects);
 boQuerySpec.setQueryBase(boQuery1);
 

See Also:

PreConditionObject, DataSourceObject, DataSourceSpecification, QueryObject, Query

Nested Class Summary

static class

PreCondition.Factory A class with methods for creating instances of the PreCondition type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getKey() Gets the key stored in the PreCondition instance.
java.lang.String	getName() Gets the name stored in the PreCondition instance.
boolean	isNilName() Checks if the Name element is nil.
boolean	isSetName() Checks if the Name element is set.
void	setKey(java.lang.String key) Sets the key stored in the PreCondition instance.
void	setName(java.lang.String name) Sets the name stored in the PreCondition instance.
void	setNilName() Nils the Name element.
void	unsetName() Deletes or unsets the Name element.
org.apache.xmlbeans.XmlString	xgetKey() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetKey(org.apache.xmlbeans.XmlString key) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.

Methods inherited from interface com.businessobjects.query.ConditionBase

getID, isSetID, setID, unsetID, xgetID, xsetID

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getName

java.lang.String getName()

Gets the name stored in the PreCondition instance.

Returns:

The name stored in the PreCondition instance.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

isNilName

boolean isNilName()

Checks if the Name element is nil.

Returns:

true if the Name element is nil, otherwise false.

isSetName

boolean isSetName()

Checks if the Name element is set.

Returns:

true if the Name element is set, otherwise false.

setName

void setName(java.lang.String name)

Sets the name stored in the PreCondition instance. Usually, you would set this to the name of the PreConditionObject object represented by this PreCondition instance.

Parameters:

name - the name stored in the PreCondition instance.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

setNilName

void setNilName()

Nils the Name element.

unsetName

void unsetName()

Deletes or unsets the Name element.

getKey

java.lang.String getKey()

Gets the key stored in the PreCondition instance. The key should be set to the key of a PreConditionObject object that you have obtained from the Universe (data source).

Returns:

The key of the PreConditionObject object represented by this PreCondition

xgetKey

org.apache.xmlbeans.XmlString xgetKey()

Internal Use Only.

setKey

void setKey(java.lang.String key)

Sets the key stored in the PreCondition instance. The key should be set to the key of a PreConditionObject object that you have obtained from the Universe (data source).

Parameters:

key - the key of a PreConditionObject object to be represented by this PreCondition

xsetKey

void xsetKey(org.apache.xmlbeans.XmlString key)

Internal Use Only.