Class Choice

    • Method Detail

      • choiceId

        public final String choiceId()
        Returns the value of the ChoiceId property for this object.
        Returns:
        The value of the ChoiceId property for this object.
      • title

        public final String title()
        Returns the value of the Title property for this object.
        Returns:
        The value of the Title property for this object.
      • description

        public final String description()
        Returns the value of the Description property for this object.
        Returns:
        The value of the Description property for this object.
      • helpfulResource

        public final ChoiceContent helpfulResource()

        The helpful resource (both text and URL) for a particular choice.

        This field only applies to custom lenses. Each choice can have only one helpful resource.

        Returns:
        The helpful resource (both text and URL) for a particular choice.

        This field only applies to custom lenses. Each choice can have only one helpful resource.

      • improvementPlan

        public final ChoiceContent improvementPlan()

        The improvement plan (both text and URL) for a particular choice.

        This field only applies to custom lenses. Each choice can have only one improvement plan.

        Returns:
        The improvement plan (both text and URL) for a particular choice.

        This field only applies to custom lenses. Each choice can have only one improvement plan.

      • hasAdditionalResources

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

        public final List<AdditionalResources> additionalResources()

        The additional resources for a choice in a custom lens.

        A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

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

        Returns:
        The additional resources for a choice in a custom lens.

        A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

      • serializableBuilderClass

        public static Class<? extends Choice.Builder> serializableBuilderClass()
      • 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)