Class ReviewTemplateAnswerSummary

    • Method Detail

      • questionId

        public final String questionId()
        Returns the value of the QuestionId property for this object.
        Returns:
        The value of the QuestionId property for this object.
      • pillarId

        public final String pillarId()
        Returns the value of the PillarId property for this object.
        Returns:
        The value of the PillarId property for this object.
      • questionTitle

        public final String questionTitle()
        Returns the value of the QuestionTitle property for this object.
        Returns:
        The value of the QuestionTitle property for this object.
      • hasChoices

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

        public final List<Choice> choices()
        Returns the value of the Choices property for this object.

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

        Returns:
        The value of the Choices property for this object.
      • hasSelectedChoices

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

        public final List<String> selectedChoices()
        Returns the value of the SelectedChoices property for this object.

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

        Returns:
        The value of the SelectedChoices property for this object.
      • hasChoiceAnswerSummaries

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

        public final List<ChoiceAnswerSummary> choiceAnswerSummaries()

        A list of selected choices to a question in the review 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 hasChoiceAnswerSummaries() method.

        Returns:
        A list of selected choices to a question in the review template.
      • isApplicable

        public final Boolean isApplicable()
        Returns the value of the IsApplicable property for this object.
        Returns:
        The value of the IsApplicable property for this object.
      • reason

        public final AnswerReason reason()

        The reason why a choice is not-applicable to a question in the review template.

        If the service returns an enum value that is not available in the current SDK version, reason will return AnswerReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().

        Returns:
        The reason why a choice is not-applicable to a question in the review template.
        See Also:
        AnswerReason
      • reasonAsString

        public final String reasonAsString()

        The reason why a choice is not-applicable to a question in the review template.

        If the service returns an enum value that is not available in the current SDK version, reason will return AnswerReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().

        Returns:
        The reason why a choice is not-applicable to a question in the review template.
        See Also:
        AnswerReason
      • 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)