Package com.ptc.windchill.option.server

Class OptionsClientHelper

java.lang.Object

com.ptc.windchill.option.server.OptionsClientHelper

public class OptionsClientHelper
extends Object

A helper for Options clients.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
static Collection<ChoiceSuggestionBean>	getSuggestionsForContext(WTContainerRef containerRef, String searchTerm, int max_result)	Returns the the collection of Suggest Result.
static Collection<ChoiceSuggestionBean>	getSuggestionsForOptionSet(ObjectReference optionSetRef, WTContainerRef containerRef, String searchTerm, int max_result)	Returns the the collection of Suggest Result.
static Collection<ChoiceSuggestionBean>	getSuggestionsForOptionSet(ObjectReference optionSetRef, WTContainerRef containerRef, String searchTerm, int max_result, boolean suggestAliasExpression)	Returns the the collection of Suggest Result.
static boolean	isNumberBasedDisplayEnabled()	Checks if the choice display preference for rules and expression is set to Number Supported API: true

Methods inherited from class java.lang.Object

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

Method Details

getSuggestionsForContext

public static Collection<ChoiceSuggestionBean> getSuggestionsForContext(WTContainerRef containerRef,
 String searchTerm,
 int max_result)
                                                                 throws WTException

Returns the the collection of Suggest Result. suggest result contains information of Choice/Alias. Example:Choice Name, Option Name, Container Name

Supported API: true

Parameters:

searchTerm - -The string used to search choices/aliases in the specified container

max_result - - Number of suggestions to be fetched from query to show on UI

container - - The WTContainer to find suggestions

Returns:

The Collection of SuggestResult

Throws:

WTException - if a called method does

getSuggestionsForOptionSet

public static Collection<ChoiceSuggestionBean> getSuggestionsForOptionSet(ObjectReference optionSetRef,
 WTContainerRef containerRef,
 String searchTerm,
 int max_result)
                                                                   throws WTException

Returns the the collection of Suggest Result. suggest result contains information of Choice/Alias. Example:Choice Name, Option Name, Container Name

Supported API: true

Parameters:

optionSetRef - - The ObjectReference to find suggestions

containerRef - - The WTContainerRef to find suggestions

searchTerm - -The string used to search choices/aliases in the specified container

max_result - - Number of suggestions to be fetched from query to show on UI

Returns:

The Collection of SuggestResult

Throws:

WTException - if a called method does

getSuggestionsForOptionSet

public static Collection<ChoiceSuggestionBean> getSuggestionsForOptionSet(ObjectReference optionSetRef,
 WTContainerRef containerRef,
 String searchTerm,
 int max_result,
 boolean suggestAliasExpression)
                                                                   throws WTException

Returns the the collection of Suggest Result. suggest result contains information of Choice/Alias. Example:Choice Name, Option Name, Container Name

Supported API: true

Parameters:

optionSetRef - - The ObjectReference to find suggestions

containerRef - - The WTContainerRef to find suggestions

searchTerm - -The string used to search choices/aliases in the specified container

max_result - - Number of suggestions to be fetched from query to show on UI

findAliasSuggestions - - boolean to control suggestion of alias expressions

Returns:

The Collection of SuggestResult

Throws:

WTException - if a called method does

isNumberBasedDisplayEnabled

public static boolean isNumberBasedDisplayEnabled()
                                           throws WTException

Checks if the choice display preference for rules and expression is set to Number

Supported API: true

Returns:

true/false based on the preference

Throws:

WTException - if a called method does