wt.query.template
Class ReportTemplateQueryHelper

java.lang.Object
  wt.query.template.ReportTemplateQueryHelper

All Implemented Interfaces:

RemoteAccess

public class ReportTemplateQueryHelper
extends Object
implements RemoteAccess

This class provides static helper methods for building and executing queries for ReportTemplates.

Supported API: true

Extendable: false

Field Summary

static int	CONTAINER_INDEX From index of the Container class in the QuerySpecs that are built.
static int	REPORT_TEMPLATE_INDEX From index of the ReportTemplate class in the QuerySpecs that are built.

Method Summary

static void	appendNameCondition(String a_nameValue, boolean a_wildcard, LogicalOperator a_logicalOperator, int a_fromIndex, QuerySpec a_querySpec) This method appends a "name" attribute condition to the specified criteria.
static ReportTemplate	find(String a_nameValue, WTContainerRef a_containerReference, boolean a_hierarchicalContainerLookup) This method executes a query to find the specfied ReportTemplate.
static QueryResult	find(WTContainerRef a_containerReference, boolean a_hierarchicalContainerLookup, String[] a_reportTemplateAttributes, String[] a_containerAttributes, WhereExpression a_whereExpression, OrderBy[] a_orderBy) This method builds and executes a QuerySpec.
static QueryResult	find(WTContainerRef a_containerReference, boolean a_hierarchicalContainerLookup, String[] a_reportTemplateAttributes, WhereExpression a_whereExpression, OrderBy[] a_orderBy) This method builds and executes a QuerySpec.
static WTReference	findReference(String a_nameValue, WTContainerRef a_containerReference) This method executes a query to find the specfied ReportTemplate reference.
static QuerySpec	newQuerySpec(WTContainerRef a_containerReference, boolean a_hierarchicalContainerLookup) This method builds a partial QuerySpec.
static QuerySpec	newQuerySpec(WTContainerRef a_containerReference, boolean a_hierarchicalContainerLookup, String[] a_reportTemplateAttributes) This method builds a QuerySpec.
static QuerySpec	newQuerySpec(WTContainerRef a_containerReference, boolean a_hierarchicalContainerLookup, String[] a_reportTemplateAttributes, String[] a_containerAttributes) This method builds a QuerySpec.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REPORT_TEMPLATE_INDEX

public static final int REPORT_TEMPLATE_INDEX

From index of the ReportTemplate class in the QuerySpecs that are built.

Supported API: true

See Also:

Constant Field Values

CONTAINER_INDEX

public static final int CONTAINER_INDEX

From index of the Container class in the QuerySpecs that are built.

Supported API: true

See Also:

Constant Field Values

Method Detail

newQuerySpec

public static QuerySpec newQuerySpec(WTContainerRef a_containerReference,
                                     boolean a_hierarchicalContainerLookup)
                              throws WTException

This method builds a partial QuerySpec. The ReportTemplate class is added at REPORT_TEMPLATE_INDEX with no select, criteria, or sorting specified. Container criteria are applied, if the container reference is non-null.

Supported API: true

Parameters:

a_containerReference - Specifies the container reference to use for criteria.

a_hierarchicalContainerLookup - Specifies whether the container criteria should be hierarchical. If true, then the criteria will match the specified container or any of its parent containers. If false, then only the specified container wil be matched.

Returns:

QuerySpec

Throws:

WTException

appendNameCondition

public static void appendNameCondition(String a_nameValue,
                                       boolean a_wildcard,
                                       LogicalOperator a_logicalOperator,
                                       int a_fromIndex,
                                       QuerySpec a_querySpec)
                                throws WTException

This method appends a "name" attribute condition to the specified criteria. If the name value is null, then nothing is appended. If the name value contains a database wildcard, then a LIKE condition is created. Otherwise, an EQUAL condition is created.

Supported API: true

Parameters:

a_nameValue - Specifies the "name" value to use for the condition. If the name value is null, then nothing is appended. If the name value contains a database wildcard, then a LIKE condition is created. Otherwise, an EQUAL condition is created.

a_wildcard - Indicates if wildcard condition should be used. If true, then a LIKE condition is created. Otherwise, an EQUAL condition is created.

a_logicalOperator - Specifies the LogicalOperator to use when appending the condition to a QuerySpec with existing criteria. If null, then AND is used.

a_fromIndex - The From clause index of the ReportTemplate class in the specified QuerySpec.

a_querySpec - The QuerySpec to append the condition to.

Throws:

WTException

find

public static ReportTemplate find(String a_nameValue,
                                  WTContainerRef a_containerReference,
                                  boolean a_hierarchicalContainerLookup)
                           throws WTException

This method executes a query to find the specfied ReportTemplate.

Supported API: true

Parameters:

a_nameValue - Specifies the "name" value to use for the condition. If the name value contains a database wildcard, then a LIKE condition is created. Otherwise, an EQUAL condition is created. If the name value is null, then no query is executed and null is returned.

a_containerReference - Specifies the container reference to use for criteria.

a_hierarchicalContainerLookup - Specifies whether the container criteria should be hierarchical. If true, then the criteria will match the specified container or the first matching parent container, recursively. If false, then only the specified container will be searched.

Returns:

ReportTemplate

Throws:

WTException

findReference

public static WTReference findReference(String a_nameValue,
                                        WTContainerRef a_containerReference)
                                 throws WTException

This method executes a query to find the specfied ReportTemplate reference.

Supported API: true

Parameters:

a_nameValue - Specifies the "name" value to use for the condition. If the name value contains a database wildcard, then a LIKE condition is created. Otherwise, an EQUAL condition is created. If the name value is null, then no query is executed and null is returned.

a_containerReference - Specifies the container reference to use for criteria.

Returns:

WTReference

Throws:

WTException

newQuerySpec

public static QuerySpec newQuerySpec(WTContainerRef a_containerReference,
                                     boolean a_hierarchicalContainerLookup,
                                     String[] a_reportTemplateAttributes,
                                     String[] a_containerAttributes)
                              throws WTException

This method builds a QuerySpec. The ReportTemplate class is added at REPORT_TEMPLATE_INDEX and the WTContainer class is added at CONTAINER_INDEX. No criteria or sorting is specified. Container criteria are applied, if the container reference is non-null.

Supported API: true

Parameters:

a_containerReference - Specifies the container reference to use for criteria.

a_hierarchicalContainerLookup - Specifies whether the container criteria should be hierarchical. If true, then the criteria will match the specified container or any of its parent containers. If false, then only the specified container wil be matched.

a_reportTemplateAttributes - Array of ReportTemplate attribute names to select in the query. If null, then the entire Persistable is selected.

a_containerAttributes - Array of WTContainer attribute names to select in the query. If null, then the entire Persistable is selected.

Returns:

QuerySpec

Throws:

WTException

newQuerySpec

public static QuerySpec newQuerySpec(WTContainerRef a_containerReference,
                                     boolean a_hierarchicalContainerLookup,
                                     String[] a_reportTemplateAttributes)
                              throws WTException

This method builds a QuerySpec. The ReportTemplate class is added at REPORT_TEMPLATE_INDEX and no criteria or sorting is specified. Container criteria are applied, if the container reference is non-null.

Supported API: true

Parameters:

a_containerReference - Specifies the container reference to use for criteria.

a_hierarchicalContainerLookup - Specifies whether the container criteria should be hierarchical. If true, then the criteria will match the specified container or any of its parent containers. If false, then only the specified container wil be matched.

a_reportTemplateAttributes - Array of ReportTemplate attribute names to select in the query. If null, then the entire Persistable is selected.

Returns:

QuerySpec

Throws:

WTException

find

public static QueryResult find(WTContainerRef a_containerReference,
                               boolean a_hierarchicalContainerLookup,
                               String[] a_reportTemplateAttributes,
                               String[] a_containerAttributes,
                               WhereExpression a_whereExpression,
                               OrderBy[] a_orderBy)
                        throws WTException

This method builds and executes a QuerySpec. Container criteria are applied, if the container reference is non-null.

Supported API: true

Parameters:

a_containerReference - Specifies the container reference to use for criteria.

a_hierarchicalContainerLookup - Specifies whether the container criteria should be hierarchical. If true, then the criteria will match the specified container or any of its parent containers. If false, then only the specified container wil be matched.

a_reportTemplateAttributes - Array of ReportTemplate attribute names to select in the query. If null, then the entire Persistable is selected.

a_containerAttributes - Array of WTContainer attribute names to select in the query. If null, then the entire Persistable is selected.

a_whereExpression - WhereExpression to use for the query.

a_orderBy - Array of OrderBy instance to use for the query.

Returns:

QueryResult

Throws:

WTException

find

public static QueryResult find(WTContainerRef a_containerReference,
                               boolean a_hierarchicalContainerLookup,
                               String[] a_reportTemplateAttributes,
                               WhereExpression a_whereExpression,
                               OrderBy[] a_orderBy)
                        throws WTException

This method builds and executes a QuerySpec. Container criteria are applied, if the container reference is non-null.

Supported API: true

Parameters:

a_containerReference - Specifies the container reference to use for criteria.

a_hierarchicalContainerLookup - Specifies whether the container criteria should be hierarchical. If true, then the criteria will match the specified container or any of its parent containers. If false, then only the specified container wil be matched.

a_reportTemplateAttributes - Array of ReportTemplate attribute names to select in the query. If null, then the entire Persistable is selected.

a_whereExpression - WhereExpression to use for the query.

a_orderBy - Array of OrderBy instance to use for the query.

Returns:

QueryResult

Throws:

WTException