Class BodySectionRepeatConfiguration

    • Method Detail

      • hasDimensionConfigurations

        public final boolean hasDimensionConfigurations()
        For responses, this returns true if the service returned a value for the DimensionConfigurations 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.
      • dimensionConfigurations

        public final List<BodySectionRepeatDimensionConfiguration> dimensionConfigurations()

        List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

        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 hasDimensionConfigurations() method.

        Returns:
        List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.
      • pageBreakConfiguration

        public final BodySectionRepeatPageBreakConfiguration pageBreakConfiguration()

        Page break configuration to apply for each repeating instance.

        Returns:
        Page break configuration to apply for each repeating instance.
      • hasNonRepeatingVisuals

        public final boolean hasNonRepeatingVisuals()
        For responses, this returns true if the service returned a value for the NonRepeatingVisuals 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.
      • nonRepeatingVisuals

        public final List<String> nonRepeatingVisuals()

        List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

        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 hasNonRepeatingVisuals() method.

        Returns:
        List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)