com.bmc.arsys.api
Class QueryBase

java.lang.Object
  com.bmc.arsys.api.QueryBase

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

RecursiveQuery, RegularQuery, ValueSetQuery

public abstract class QueryBase
extends Object
implements Cloneable

The QueryBase class is used to define the properties of a dynamic query.

See Also:

RegularQuery, RecursiveQuery, IQuerySource

Constructor Summary

QueryBase()

Method Summary

boolean	addFromField(int fieldId, int funcId, IQuerySource sourceForm) Adds a new item to the list of the QueryFormField fields that the dynamic query selects.
boolean	addFromField(int fieldId, IQuerySource sourceForm) Adds a new item to the list of the QueryFormField fields that the dynamic query selects.
boolean	addFromField(QueryFormField field) Adds a new item to the list of the QueryFormField fields that the dynamic query selects.
boolean	addFromSource(IQuerySource source) Adds a new item to the list of the IQuerySource sources that the dynamic query selects from.
boolean	addGroupBy(QueryFormField groupBy) Adds new having object to the list
boolean	addHaving(QualifierInfo having) Adds new having object to the list
Object	clone() Clone implementation that returns an Object with data cloned from self.
List<QueryFormField>	getFromFields() Returns a list of the QueryFormField fields that the dynamic query selects.
List<IQuerySource>	getFromSources() Returns a list of the IQuerySource sources that the dynamic query selects from.
List<QueryFormField>	getGroupBy() Returns a list of QueryFormField objects
QualifierInfo	getHaving() Returns a list of having objects
List<QualifierInfo>	getHavingList() Returns a list of having objects
QualifierInfo	getQualifier() Returns a qualifier for the dynamic query
void	setFromFields(List<QueryFormField> fromFields) Sets the list of the QueryFormField fields that the dynamic query selects.
void	setFromSources(List<IQuerySource> sources) Sets the list of the IQuerySource sources that the dynamic query selects from.
void	setGroupBy(List<QueryFormField> groupBy) Sets a list of QueryFormField objects
void	setHaving(List<QualifierInfo> having) Sets a list of QualifierInfo objects
void	setQualifier(QualifierInfo qualifier) Sets the qualifier for the dynamic query
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryBase

public QueryBase()

Method Detail

getFromSources

public List<IQuerySource> getFromSources()

Returns a list of the IQuerySource sources that the dynamic query selects from.

setFromSources

public void setFromSources(List<IQuerySource> sources)

Sets the list of the IQuerySource sources that the dynamic query selects from.

getFromFields

public List<QueryFormField> getFromFields()

Returns a list of the QueryFormField fields that the dynamic query selects.

setFromFields

public void setFromFields(List<QueryFormField> fromFields)

Sets the list of the QueryFormField fields that the dynamic query selects.

getQualifier

public QualifierInfo getQualifier()

Returns a qualifier for the dynamic query

setQualifier

public void setQualifier(QualifierInfo qualifier)

Sets the qualifier for the dynamic query

addFromSource

public boolean addFromSource(IQuerySource source)

Adds a new item to the list of the IQuerySource sources that the dynamic query selects from.

See Also:

QuerySourceForm.setJoin(com.bmc.arsys.api.IQuerySource, int, com.bmc.arsys.api.QualifierInfo)

addFromField

public boolean addFromField(QueryFormField field)

Adds a new item to the list of the QueryFormField fields that the dynamic query selects.

addFromField

public boolean addFromField(int fieldId,
                            int funcId,
                            IQuerySource sourceForm)

Adds a new item to the list of the QueryFormField fields that the dynamic query selects.

addFromField

public boolean addFromField(int fieldId,
                            IQuerySource sourceForm)

Adds a new item to the list of the QueryFormField fields that the dynamic query selects.

setHaving

public void setHaving(List<QualifierInfo> having)

Sets a list of QualifierInfo objects

setGroupBy

public void setGroupBy(List<QueryFormField> groupBy)

Sets a list of QueryFormField objects

getHavingList

public List<QualifierInfo> getHavingList()

Returns a list of having objects

getHaving

public QualifierInfo getHaving()

Returns a list of having objects

getGroupBy

public List<QueryFormField> getGroupBy()

Returns a list of QueryFormField objects

addHaving

public boolean addHaving(QualifierInfo having)

Adds new having object to the list

addGroupBy

public boolean addGroupBy(QueryFormField groupBy)

Adds new having object to the list

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object