Package com.veeva.vault.sdk.api.i18n

Interface TranslationsReadRequestBuilder

public interface TranslationsReadRequestBuilder
Provides methods to build TranslationsReadRequest objects.

  • Method Details

    • build

      TranslationsReadRequest build()
      Builds a new TranslationsReadRequest object.
      Returns:
      a TranslationsReadRequest object
      Throws:
      IllegalArgumentException - if Messagegroup is null or empty

    • withMessageGroup

      TranslationsReadRequestBuilder withMessageGroup(String messageGroupName)
      Specifies the name of a Messagegroup. For example, control__c.
      Parameters:
      messageGroupName - not null or empty, name of a Messagegroup
      Returns:
      this translation read request builder

    • withMessages

      TranslationsReadRequestBuilder withMessages(List<String> messageNames)
      Specifies a collection of Message names. For example, [max__c, min__c]. If not specified, all Messages in the Messagegroup are returned.
      Parameters:
      messageNames - collection of Message names in the given Messagegroup
      Returns:
      this translation read request builder

    • withLanguage

      TranslationsReadRequestBuilder withLanguage(String language)
      Specifies the Vault-supported language code. For example, en, ja, zh.
      Parameters:
      language - optional Vault-supported language code. If not supplied translation read in current user's language
      Returns:
      this translation read request builder

    • withLabelSet

      TranslationsReadRequestBuilder withLabelSet(String labelSet)
      Specifies the name of the Vault-supported label set. For example, medical_english__v.
      Parameters:
      labelSet - optional label set. If not supplied, use the current user's label set, empty of none.
      Returns:
      this translation read request builder