Package com.ptc.windchill.option.server
Interface OptionsClientService
- All Known Implementing Classes:
StandardOptionsClientService
A service for clients that use Options.
Supported API: true
Extendable: false
Supported API: true
Extendable: false
-
Method Summary
Modifier and TypeMethodDescriptiongetOptionSetInfo(OptionSet optionset, List<ATORuleConfigSpec> configSpecs) API to to return OptionSetInfo
Supported API: truegetOptionSetInfo(String optionsetname, List<ATORuleConfigSpec> configSpecs) API to to return OptionSetInfo
Supported API: truegetOptionSetInfo(WTReference optionsetRef, List<ATORuleConfigSpec> configSpecs) API to to return OptionSetInfo
Supported API: truegetSuggestionBeanResults(WTContainerRef parentRef, String searchTerm, int max_result) API to to return Collection of ChoiceSuggestionBean.getSuggestionsFromOptionSet(ObjectReference optionSetRef, WTContainerRef parentRef, String searchTerm, int max_result) API to to return Collection of ChoiceSuggestionBean.getSuggestionsFromOptionSet(ObjectReference optionSetRef, WTContainerRef parentRef, String searchTerm, int max_result, boolean suggestAliasExpression) API to to return Collection of ChoiceSuggestionBean.
-
Method Details
-
getOptionSetInfo
OptionSetInfo getOptionSetInfo(String optionsetname, List<ATORuleConfigSpec> configSpecs) throws WTException API to to return OptionSetInfo
Supported API: true- Parameters:
optionsetname-configSpecs-- Returns:
- Throws:
WTException
-
getOptionSetInfo
OptionSetInfo getOptionSetInfo(WTReference optionsetRef, List<ATORuleConfigSpec> configSpecs) throws WTException API to to return OptionSetInfo
Supported API: true- Parameters:
optionsetRef-configSpecs-- Returns:
- Throws:
WTException
-
getOptionSetInfo
OptionSetInfo getOptionSetInfo(OptionSet optionset, List<ATORuleConfigSpec> configSpecs) throws WTException API to to return OptionSetInfo
Supported API: true- Parameters:
optionset-configSpecs-- Returns:
- Throws:
WTException
-
getSuggestionBeanResults
Collection<ChoiceSuggestionBean> getSuggestionBeanResults(WTContainerRef parentRef, String searchTerm, int max_result) throws WTException API to to return Collection of ChoiceSuggestionBean.
Supported API: true- Parameters:
parentRef- -The Object reference to the organization to find suggestionssearchTerm- - The string used to search choices/aliases in the specified Organizationmax_result-- Returns:
- The collection of ChoiceSuggestionBean
- Throws:
WTException
-
getSuggestionsFromOptionSet
Collection<ChoiceSuggestionBean> getSuggestionsFromOptionSet(ObjectReference optionSetRef, WTContainerRef parentRef, String searchTerm, int max_result) throws WTException API to to return Collection of ChoiceSuggestionBean.
Supported API: true- Parameters:
optionSetRef- -The Object reference to the OptionSet to find suggestion of choice and OptionparentRef- -The Object reference to the organization to find suggestion for AliassearchTerm- - The string used to search choices/aliasesmax_result-- Returns:
- The collection of ChoiceSuggestionBean
- Throws:
WTException
-
getSuggestionsFromOptionSet
Collection<ChoiceSuggestionBean> getSuggestionsFromOptionSet(ObjectReference optionSetRef, WTContainerRef parentRef, String searchTerm, int max_result, boolean suggestAliasExpression) throws WTException API to to return Collection of ChoiceSuggestionBean.
Supported API: true- Parameters:
optionSetRef- -The Object reference to the OptionSet to find suggestion of choice and OptionparentRef- -The Object reference to the organization to find suggestion for AliassearchTerm- - The string used to search choices/aliasesmax_result-findAliasSuggestions- - boolean to control suggestion of alias expressions- Returns:
- The collection of ChoiceSuggestionBean
- Throws:
WTException
-