com.ptc.core.query.common
Class BasicResultSpec

java.lang.Object
  com.ptc.core.meta.container.common.AttributeContainerSpec
      com.ptc.core.query.common.BasicResultSpec

All Implemented Interfaces:

com.ptc.core.meta.common.AttributeTypeIdentifierList, ResultSpec, Externalizable, Serializable

public class BasicResultSpec
extends AttributeContainerSpec
implements ResultSpec, Externalizable

This class provides a basic implementation of a result specification. The AttributeTypeIdentifiers can be dynamically added to or removed from the list.

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

BasicResultSpec(AttributeTypeIdentifier[] a_attributeTypeIdentifiers)


Supported API: true

Method Summary

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	setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled) Sets 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.
void	setTargetDataTypeIdentifiers(TypeIdentifier[] a_TargetDataTypeIdentifiers) Sets the value of the attribute: targetDataTypeIdentifiers; The list of target TypeIdentifiers that is are used as AttributeTypeIdentifier context data types.

Methods inherited from class com.ptc.core.meta.container.common.AttributeContainerSpec

getNextOperation, putEntries, putEntries, putEntries, putEntry, putEntry, removeEntry, setNextOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicResultSpec

public BasicResultSpec(AttributeTypeIdentifier[] a_attributeTypeIdentifiers)

Supported API: true

Parameters:

a_attributeTypeIdentifiers - Array of AttributeTypeIdentifiers

Method Detail

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

setTargetDataTypeIdentifiers

public void setTargetDataTypeIdentifiers(TypeIdentifier[] a_TargetDataTypeIdentifiers)
                                  throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_TargetDataTypeIdentifiers -

Throws:

WTPropertyVetoException

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

setAdvancedQueryEnabled

public void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)

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

Supported API: true

Parameters:

a_AdvancedQueryEnabled -

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