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

Class DefaultObjectReferenceAttributeSearchDelegate

java.lang.Object

com.ptc.windchill.baseclient.server.delegate.DefaultObjectReferenceAttributeSearchDelegate

All Implemented Interfaces:

ObjectReferenceAttributeSearchDelegate

public class DefaultObjectReferenceAttributeSearchDelegate
extends Object
implements ObjectReferenceAttributeSearchDelegate

WARNING : This class is is performing sensitive query. Please make sure this is well performed

Supported API: true

Extendable: true

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)	Supported API: true
TypeInstance[]	executeQuerySearch(com.ptc.cat.ops.client.internal.FindOperation.FindOperationParams fop, TypeIdentifier[] result_types, com.ptc.cat.entity.client.Identifier selectedObject, String ncid)	Deprecated. - as of13.0.1.0 use executeQuerySearch(Attribute, TypeIdentifier, String, TypeIdentifier[], ObjectReference, String) Supported API: true
com.ptc.cat.entity.client.attribute.Attribute	getDisplayAttribute()	Supported API: true

Methods inherited from class java.lang.Object

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

Method Details

executeQuerySearch

@Deprecated
public TypeInstance[] executeQuerySearch(com.ptc.cat.ops.client.internal.FindOperation.FindOperationParams fop,
 TypeIdentifier[] result_types,
 com.ptc.cat.entity.client.Identifier selectedObject,
 String ncid)
                                  throws WTException

Deprecated.

- as of13.0.1.0 use executeQuerySearch(Attribute, TypeIdentifier, String, TypeIdentifier[], ObjectReference, String)
Supported API: true

Description copied from interface: ObjectReferenceAttributeSearchDelegate

This method is use to execute the search based on the params and the result type

Specified by:

executeQuerySearch in interface ObjectReferenceAttributeSearchDelegate

Parameters:

fop - 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

executeQuerySearch

public TypeInstance[] executeQuerySearch(com.ptc.cat.entity.client.attribute.Attribute attribute,
 TypeIdentifier typeIdentifier,
 String searchQuery,
 TypeIdentifier[] result_types,
 ObjectReference or,
 String ncid)
                                  throws WTException

Supported API: true

Specified by:

executeQuerySearch in interface ObjectReferenceAttributeSearchDelegate

Parameters:

attribute -

typeIdentifier -

searchQuery -

result_types -

or -

ncid -

Returns:

Throws:

WTException -
Supported API: true

getDisplayAttribute

public com.ptc.cat.entity.client.attribute.Attribute getDisplayAttribute()

Supported API: true

Specified by:

getDisplayAttribute in interface ObjectReferenceAttributeSearchDelegate

Returns:

attribute name

Supported API: true