Class ChangeSummary

    • Method Detail

      • changeType

        public final String changeType()

        The type of the change.

        Returns:
        The type of the change.
      • entity

        public final Entity entity()

        The entity to be changed.

        Returns:
        The entity to be changed.
      • details

        public final String details()

        This object contains details specific to the change type of the requested change.

        Returns:
        This object contains details specific to the change type of the requested change.
      • detailsDocument

        public final Document detailsDocument()

        The JSON value of the details specific to the change type of the requested change.

        Returns:
        The JSON value of the details specific to the change type of the requested change.
      • hasErrorDetailList

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

        public final List<ErrorDetail> errorDetailList()

        An array of ErrorDetail objects associated with the change.

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

        Returns:
        An array of ErrorDetail objects associated with the change.
      • changeName

        public final String changeName()

        Optional name for the change.

        Returns:
        Optional name for the change.
      • 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)