Package com.ptc.windchill.baseclient.server.delegate

Interface ObjectReferenceAttributeSearchDelegate

All Known Implementing Classes:
DefaultObjectReferenceAttributeSearchDelegate
public interface ObjectReferenceAttributeSearchDelegate
Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    TypeInstance[]
    executeQuerySearch(com.ptc.cat.entity.client.attribute.Attribute attribute, TypeIdentifier typeIdentifier, String searchQuery, TypeIdentifier[] result_types, ObjectReference or, String ncid)
    This method is use to execute the search based on the params and the result type
    TypeInstance[]
    executeQuerySearch(com.ptc.cat.ops.client.internal.FindOperation.FindOperationParams findOperationParams, TypeIdentifier[] result_types, com.ptc.cat.entity.client.Identifier selectedObject, String ncid)
    Deprecated.
    - as of13.0.1.0 use
    invalid reference 
    ObjectReferenceAttributeSearchDelegate#executeQuerySearch(FindOperationParams, TypeIdentifier[], ObjectReference, String)
    com.ptc.cat.entity.client.attribute.Attribute
    getDisplayAttribute()
    This method is used the get the attribute name which is specified in the delegate

  • Method Details

    • executeQuerySearch

      TypeInstance[] executeQuerySearch(com.ptc.cat.ops.client.internal.FindOperation.FindOperationParams findOperationParams, TypeIdentifier[] result_types, com.ptc.cat.entity.client.Identifier selectedObject, String ncid) throws WTException
      Deprecated.
      - as of13.0.1.0 use
      invalid reference 
      ObjectReferenceAttributeSearchDelegate#executeQuerySearch(FindOperationParams, TypeIdentifier[], ObjectReference, String)
      This method is use to execute the search based on the params and the result type
      Parameters:
      findOperationParams - The Find Operation Params that will be used to get the Search Criteria List from which the query criteria will be calculated
      result_types - The types expected as output from the query
      selectedObject - the selected object identifier
      ncid - ncid
      Returns:
      A list of TypeInstances matching to the query up to the configured limit

      Supported API: true

      Throws:
      WTException

    • getDisplayAttribute

      com.ptc.cat.entity.client.attribute.Attribute getDisplayAttribute()
      This method is used the get the attribute name which is specified in the delegate
      Returns:
      attribute name

      Supported API: true

    • executeQuerySearch

      TypeInstance[] executeQuerySearch(com.ptc.cat.entity.client.attribute.Attribute attribute, TypeIdentifier typeIdentifier, String searchQuery, TypeIdentifier[] result_types, ObjectReference or, String ncid) throws WTException
      This method is use to execute the search based on the params and the result type
      Parameters:
      attribute -
      typeIdentifier -
      searchQuery -
      result_types -
      or -
      ncid -
      Returns:
      Throws:
      WTException -
      Supported API: true