Package 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:
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:

  • Constructor Details

    • BasicResultSpec

      public BasicResultSpec(AttributeTypeIdentifier[] a_attributeTypeIdentifiers)


      Supported API: true
      Parameters:
      a_attributeTypeIdentifiers - Array of AttributeTypeIdentifiers

  • Method Details

    • 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