Class UpdateTemplateRequest

    • Method Detail

      • description

        public final String description()

        A brief description of the template.

        Returns:
        A brief description of the template.
      • domainId

        public final String domainId()

        The unique identifier of the Cases domain.

        Returns:
        The unique identifier of the Cases domain.
      • layoutConfiguration

        public final LayoutConfiguration layoutConfiguration()

        Configuration of layouts associated to the template.

        Returns:
        Configuration of layouts associated to the template.
      • name

        public final String name()

        The name of the template. It must be unique per domain.

        Returns:
        The name of the template. It must be unique per domain.
      • hasRequiredFields

        public final boolean hasRequiredFields()
        For responses, this returns true if the service returned a value for the RequiredFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • requiredFields

        public final List<RequiredField> requiredFields()

        A list of fields that must contain a value for a case to be successfully created with this template.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiredFields() method.

        Returns:
        A list of fields that must contain a value for a case to be successfully created with this template.
      • templateId

        public final String templateId()

        A unique identifier for the template.

        Returns:
        A unique identifier for the template.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object