Package wt.preference

Interface PreferenceService2

@RemoteInterface public interface PreferenceService2
Interface specifying methods needed to provide client accessible server-side functionality for managing preferences.

Supported API: true

Extendable: false

  • Method Details

    • getValue

      default Object getValue(String definitionName, WTContainer container, WTPrincipal principal) throws WTException
      Gets the value of a preference specified by definitionName in the specified container or user context. Only considers instances of the default (WINDCHILL) client.

      Supported API: true
      Parameters:
      definitionName - The internal name of the PreferenceDefinition
      container -
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Object
      Throws:
      WTException

    • getValue

      default Object getValue(String definitionName, String clientName, WTContainer container, WTPrincipal principal) throws WTException
      Gets the value of a preference specified by definitionName in the specified container or user context. Only considers instances of clients including the passed in client and its ancestors.

      Supported API: true
      Parameters:
      definitionName - The internal name of the PreferenceDefinition
      clientName - The internal name of the PreferenceClient
      container - Container specifying the context in which the preference is being retrieved
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Object
      Throws:
      WTException

    • getValue

      Object getValue(String definitionName, String clientName, OrgContainer organization) throws WTException
      Gets the value of a preference specified by definitionName in the specified organization context. Only considers instances of clients including the passed in client and its ancestors.

      Supported API: true
      Parameters:
      definitionName - The internal name of the PreferenceDefinition
      clientName - The internal name of the PreferenceClient
      organization - Organization specifying the context in which the preference is being retrieved
      Returns:
      Object
      Throws:
      WTException

    • getValue

      Object getValue(String definitionName, String clientName) throws WTException
      Gets the value of a preference specified by definitionName in the site context. Only considers instances of clients including the passed in client and its ancestors.

      Supported API: true
      Parameters:
      definitionName - The internal name of the PreferenceDefinition
      clientName - The internal name of the PreferenceClient
      Returns:
      Object
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(Collection<String> definitionNames, WTContainer container, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames. Only considers instances of the default (WINDCHILL) client. A map which maps preference internal names to the value of the preference is returned.

      Supported API: true
      Parameters:
      definitionNames - Internal names of PreferenceDefinitions
      container - Container specifying the context in which the preference is being retrieved
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(Map<String,Object> map, Collection<String> definitionNames, WTContainer container, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames. Only considers instances of the default (WINDCHILL) client. The results will be added to the inputted map, which maps preference internal names to the value of the preference. This map is then returned.

      Supported API: true
      Parameters:
      map - Map of PreferenceDefinition internal names to values, results are added to this map and this map is returned
      definitionNames - Internal names of PreferenceDefinitions
      container - Container specifying the context in which the preference is being retrieved
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(Collection<String> definitionNames, Collection<String> categoryNames, WTContainer container, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of the default (WINDCHILL) client. A map which maps preference internal names to the value of the preference is returned.

      Supported API: true
      Parameters:
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      container - Container specifying the context in which the preference is being retrieved
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(Map<String,Object> map, Collection<String> definitionNames, Collection<String> categoryNames, WTContainer container, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of the default (WINDCHILL) client. The results will be added to the inputted map, which maps preference internal names to the value of the preference. This map is then returned.

      Supported API: true
      Parameters:
      map - Map of PreferenceDefinition internal names to values, results are added to this map and this map is returned
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      container - Container specifying the context in which the preference is being retrieved
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(Collection<String> definitionNames, Collection<String> categoryNames, String clientName, WTContainer container, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. A map which maps preference internal names to the value of the preference is returned.

      Supported API: true
      Parameters:
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      container - Container specifying the context in which the preference is being retrieved
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(Map<String,Object> map, Collection<String> definitionNames, Collection<String> categoryNames, String clientName, WTContainer container, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. The results will be added to the inputted map, which maps preference internal names to the value of the preference. This map is then returned.

      Supported API: true
      Parameters:
      map - Map of PreferenceDefinition internal names to values, results are added to this map and this map is returned
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      container - Container specifying the context in which the preference is being retrieved
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      Map<String,Object> getValues(Collection<String> definitionNames, Collection<String> categoryNames, String clientName, OrgContainer organization) throws WTException
      Gets the values of multiple preferences in an organization context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. A map which maps preference internal names to the value of the preference is returned.

      Supported API: true
      Parameters:
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      organization - Organization specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      Map<String,Object> getValues(Map<String,Object> map, Collection<String> definitionNames, Collection<String> categoryNames, String clientName, OrgContainer organization) throws WTException
      Gets the values of multiple preferences in an organization context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. The results will be added to the inputted map, which maps preference internal names to the value of the preference. This map is then returned.

      Supported API: true
      Parameters:
      map - Map of PreferenceDefinition internal names to values, results are added to this map and this map is returned
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      organization - Organization specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      Map<String,Object> getValues(Collection<String> definitionNames, Collection<String> categoryNames, String clientName) throws WTException
      Gets the values of multiple preferences in the site context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. A map which maps preference internal names to the value of the preference is returned.

      Supported API: true
      Parameters:
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      Map<String,Object> getValues(Map<String,Object> map, Collection<String> definitionNames, Collection<String> categoryNames, String clientName) throws WTException
      Gets the values of multiple preferences in the site context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. The results will be added to the inputted map, which maps preference internal names to the value of the preference. This map is then returned.

      Supported API: true
      Parameters:
      map - Map of PreferenceDefinition internal names to values, results are added to this map and this map is returned
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValue

      default Object getValue(WTPrincipal principal, String definitionName, String clientName) throws WTException
      Gets the value of a preference specified by definitionName in the specified user context. Only considers instances of clients including the passed in client and its ancestors.

      Supported API: true
      Parameters:
      definitionName - The internal name of the PreferenceDefinition
      clientName - The internal name of the PreferenceClient
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Object
      Throws:
      WTException

    • getValue

      default Object getValue(WTContainerRef containerRef, String definitionName, String clientName, WTPrincipal principal) throws WTException
      Gets the value of a preference specified by definitionName in the specified container or user context. Only considers instances of clients including the passed in client and its ancestors.

      Supported API: true
      Parameters:
      containerRef - Container reference specifying the context in which the preference is being retrieved
      definitionName - The internal name of the PreferenceDefinition
      clientName - The internal name of the PreferenceClient
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Object
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(WTContainerRef containerRef, Collection<String> definitionNames, Collection<String> categoryNames, String clientName, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. A map which maps preference internal names to the value of the preference is returned.

      Supported API: true
      Parameters:
      containerRef - Container reference specifying the context in which the preference is being retrieved
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException

    • getValues

      default Map<String,Object> getValues(WTContainerRef containerRef, Map<String,Object> map, Collection<String> definitionNames, Collection<String> categoryNames, String clientName, WTPrincipal principal) throws WTException
      Gets the values of multiple preferences in a container or user context. This will get the value of all preferences that are specified by definitionNames or that belong to the PreferenceCategories specified by categoryNames. Only considers instances of clients including the passed in client and its ancestors. The results will be added to the inputted map, which maps preference internal names to the value of the preference. This map is then returned.

      Supported API: true
      Parameters:
      containerRef - Container reference specifying the context in which the preference is being retrieved
      map - Map of PreferenceDefinition internal names to values, results are added to this map and this map is returned
      definitionNames - Internal names of PreferenceDefinitions
      categoryNames - Internal names of PreferenceCategories
      clientName - The internal name of the PreferenceClient
      user - User specifying the context in which the preference is being retrieved
      Returns:
      Mapinvalid input: '<'String,Object>
      Throws:
      WTException