Package com.ptc.core.query.common

Class DefaultResultSpec

java.lang.Object

com.ptc.core.query.common.DefaultResultSpec

All Implemented Interfaces:

AttributeTypeIdentifierList, ResultSpec, Externalizable, Serializable

public class DefaultResultSpec
extends Object
implements ResultSpec, Externalizable

This class provides a default "wrapper" implementation based on an existing AttributeTypeIdentiferList.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.ptc.core.query.common.ResultSpec

ADVANCED_QUERY_ENABLED, EXCLUDED_TYPES, TARGET_DATA_TYPE_IDENTIFIERS

Constructor Summary

Constructors

Constructor	Description
DefaultResultSpec(AttributeTypeIdentifier[] a_attributeTypeIdentifier)	Supported API: true
DefaultResultSpec(AttributeTypeIdentifierList a_list)	Supported API: true

Method Summary

Modifier and Type	Method	Description
TypeIdentifier[]	getExcludedTypes()	Gets the value of the attribute: excludedTypes; Specifies an array of TypeIdentifiers that should be excluded when processing the query.
TypeIdentifier[]	getTargetDataTypeIdentifiers()	Gets the value of the attribute: targetDataTypeIdentifiers; The list of target TypeIdentifiers that is are used as AttributeTypeIdentifier context data types.
boolean	isAdvancedQueryEnabled()	Gets the value of the attribute: advancedQueryEnabled; Indicates if the results are enabled for advanced query features.
void	setExcludedTypes(TypeIdentifier[] a_ExcludedTypes)	Sets the value of the attribute: excludedTypes; Specifies an array of TypeIdentifiers that should be excluded when processing the query.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultResultSpec

public DefaultResultSpec(AttributeTypeIdentifierList a_list)

Supported API: true

Parameters:

a_list - The list that this instance "wraps".

DefaultResultSpec

public DefaultResultSpec(AttributeTypeIdentifier[] a_attributeTypeIdentifier)

Supported API: true

Parameters:

a_attributeTypeIdentifier - The array that this instance "wraps".

Method Details

getExcludedTypes

public TypeIdentifier[] getExcludedTypes()

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

Supported API: true

Specified by:

getExcludedTypes in interface ResultSpec

Returns:

TypeIdentifier[]

setExcludedTypes

public void setExcludedTypes(TypeIdentifier[] a_ExcludedTypes)
                      throws WTPropertyVetoException

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

Supported API: true

Specified by:

setExcludedTypes in interface ResultSpec

Parameters:

a_ExcludedTypes -

Throws:

WTPropertyVetoException

getTargetDataTypeIdentifiers

public TypeIdentifier[] getTargetDataTypeIdentifiers()
                                              throws WTException

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

Supported API: true

Specified by:

getTargetDataTypeIdentifiers in interface ResultSpec

Returns:

TypeIdentifier[]

Throws:

WTException

isAdvancedQueryEnabled

public boolean isAdvancedQueryEnabled()

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

Supported API: true

Specified by:

isAdvancedQueryEnabled in interface ResultSpec

Returns:

boolean