com.ptc.core.query.common
Interface ResultSpec

All Superinterfaces:

com.ptc.core.meta.common.AttributeTypeIdentifierList

All Known Implementing Classes:

BasicResultSpec, DefaultResultSpec

public interface ResultSpec
extends com.ptc.core.meta.common.AttributeTypeIdentifierList

This interface provides the abstraction for specifying the results of a type based query. The results are specified in terms of AttributeTypeIdentifiers which identify the attributes that should be returned when the query is executed.

Supported API: true

Extendable: false

Field Summary

static String	ADVANCED_QUERY_ENABLED Label for the attribute; Indicates if the results are enabled for advanced query features.
static String	EXCLUDED_TYPES Label for the attribute; Specifies an array of TypeIdentifiers that should be excluded when processing the query.
static String	TARGET_DATA_TYPE_IDENTIFIERS Label for the attribute; The list of target TypeIdentifiers that is are used as AttributeTypeIdentifier context data types.

Method Summary

TypeIdentifier[]	getExcludedTypes() Gets the value of the attribute: EXCLUDED_TYPES.
TypeIdentifier[]	getTargetDataTypeIdentifiers() Gets the value of the attribute: TARGET_DATA_TYPE_IDENTIFIERS.
boolean	isAdvancedQueryEnabled() Gets the value of the attribute: ADVANCED_QUERY_ENABLED.
void	setExcludedTypes(TypeIdentifier[] a_ExcludedTypes) Sets the value of the attribute: EXCLUDED_TYPES.

Field Detail

TARGET_DATA_TYPE_IDENTIFIERS

static final String TARGET_DATA_TYPE_IDENTIFIERS

Label for the attribute; The list of target TypeIdentifiers that is are used as AttributeTypeIdentifier context data types.

Supported API: true

See Also:

Constant Field Values

ADVANCED_QUERY_ENABLED

static final String ADVANCED_QUERY_ENABLED

Label for the attribute; Indicates if the results are enabled for advanced query features.

Supported API: true

See Also:

Constant Field Values

EXCLUDED_TYPES

static final String EXCLUDED_TYPES

Label for the attribute; Specifies an array of TypeIdentifiers that should be excluded when processing the query.

Supported API: true

See Also:

Constant Field Values

Method Detail

getTargetDataTypeIdentifiers

TypeIdentifier[] getTargetDataTypeIdentifiers()
                                              throws WTException

Gets the value of the attribute: TARGET_DATA_TYPE_IDENTIFIERS. The list of target TypeIdentifiers that is are used as AttributeTypeIdentifier context data types.

Supported API: true

Returns:

TypeIdentifier[]

Throws:

WTException

isAdvancedQueryEnabled

boolean isAdvancedQueryEnabled()

Gets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if the results are enabled for advanced query features.

Supported API: true

Returns:

boolean

getExcludedTypes

TypeIdentifier[] getExcludedTypes()

Gets the value of the attribute: EXCLUDED_TYPES. Specifies an array of TypeIdentifiers that should be excluded when processing the query.

Supported API: true

Returns:

TypeIdentifier[]

setExcludedTypes

void setExcludedTypes(TypeIdentifier[] a_ExcludedTypes)
                      throws WTPropertyVetoException

Sets the value of the attribute: EXCLUDED_TYPES. Specifies an array of TypeIdentifiers that should be excluded when processing the query.

Supported API: true

Parameters:

a_ExcludedTypes -

Throws:

WTPropertyVetoException