Class AssessmentControl

    • Method Detail

      • id

        public final String id()

        The identifier for the control.

        Returns:
        The identifier for the control.
      • name

        public final String name()

        The name of the control.

        Returns:
        The name of the control.
      • description

        public final String description()

        The description of the control.

        Returns:
        The description of the control.
      • hasComments

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

        public final List<ControlComment> comments()

        The list of comments that's attached to the control.

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

        Returns:
        The list of comments that's attached to the control.
      • hasEvidenceSources

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

        public final List<String> evidenceSources()

        The list of data sources for the evidence.

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

        Returns:
        The list of data sources for the evidence.
      • evidenceCount

        public final Integer evidenceCount()

        The amount of evidence that's collected for the control.

        Returns:
        The amount of evidence that's collected for the control.
      • assessmentReportEvidenceCount

        public final Integer assessmentReportEvidenceCount()

        The amount of evidence in the assessment report.

        Returns:
        The amount of evidence in the assessment report.
      • 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)