Package de.espirit.firstspirit.service.treedata

Interface TNodeService

public interface TNodeService
FirstSpirit client interface for hierarchically organized data.
Since:
4.0.63

  • Method Details

    • addProvider

      void addProvider(@NotNull @NotNull String name, @NotNull @NotNull String providerClass) throws IllegalArgumentException
      Adds a provider instance to the service. Because of instantiation provider on demand, problems with the given providerClass occure not until calling getProvider(String).
      Parameters:
      name - provider name.
      providerClass - provider class.
      Throws:
      IllegalArgumentException - if a provider with the given name already exists.
      Since:
      4.0.63

    • getProviderNames

      @NotNull @NotNull Collection<String> getProviderNames()
      Returns all provider names.
      Returns:
      all provider names.
      Since:
      4.0.63

    • getProviderClass

      @Nullable @Nullable String getProviderClass(String providerName)
      Returns the provider class name for the specified provider
      Parameters:
      providerName - the name of the provider, to get the class name for
      Returns:
      the provider class name for the specified provider
      Since:
      4.0.63

    • isProviderKnown

      boolean isProviderKnown(String providerName)
      Returns true, if the specified provider is known, and false otherwise
      Parameters:
      providerName - the name of the provider
      Returns:
      true, if the specified provider is known, and false otherwise
      Since:
      4.0.63

    • getProvider

      TNodeProvider getProvider(@NotNull @NotNull String name) throws IllegalArgumentException, IllegalStateException
      Returns a provider proxy.
      Parameters:
      name - provider name.
      Returns:
      provider proxy.
      Throws:
      IllegalArgumentException - if the provider name is unknown.
      IllegalStateException - if the provider class couldn't be instantiated.
      Since:
      4.0.63

    • getProviderProperties

      @NotNull @NotNull Map<String,String> getProviderProperties(String name) throws IllegalArgumentException
      Returns properties of the specified provider.
      Parameters:
      name - provider name.
      Returns:
      properties of the specified provider.
      Throws:
      IllegalArgumentException - if the provider name is unknown.
      Since:
      4.0.63

    • setProviderProperties

      void setProviderProperties(@NotNull @NotNull String name, @NotNull @NotNull Map<String,String> properties) throws IllegalArgumentException
      Sets properties of the specified provider.
      Parameters:
      name - provider name
      properties - properties.
      Throws:
      IllegalArgumentException - if the provider name is unknown.
      Since:
      4.0.63

    • removeProvider

      void removeProvider(@NotNull @NotNull String name) throws IllegalArgumentException
      Removes a provider instance from the service.
      Parameters:
      name - provider name.
      Throws:
      IllegalArgumentException - if the provider name is unknown.
      Since:
      4.0.63