Interface OptionsClientService

All Known Implementing Classes:
StandardOptionsClientService

@RemoteInterface public interface OptionsClientService
A service for clients that use Options.

Supported API: true

Extendable: false
  • 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 suggestions
      searchTerm - - The string used to search choices/aliases in the specified Organization
      max_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 Option
      parentRef - -The Object reference to the organization to find suggestion for Alias
      searchTerm - - The string used to search choices/aliases
      max_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 Option
      parentRef - -The Object reference to the organization to find suggestion for Alias
      searchTerm - - The string used to search choices/aliases
      max_result -
      findAliasSuggestions - - boolean to control suggestion of alias expressions
      Returns:
      The collection of ChoiceSuggestionBean
      Throws:
      WTException