Class AssessmentControlSet

    • Method Detail

      • id

        public final String id()

        The identifier of the control set in the assessment. This is the control set name in a plain string format.

        Returns:
        The identifier of the control set in the assessment. This is the control set name in a plain string format.
      • description

        public final String description()

        The description for the control set.

        Returns:
        The description for the control set.
      • statusAsString

        public final String statusAsString()

        The current status of the control set.

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

        Returns:
        The current status of the control set.
        See Also:
        ControlSetStatus
      • hasRoles

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

        public final List<Role> roles()

        The roles that are associated with the control set.

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

        Returns:
        The roles that are associated with the control set.
      • hasControls

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

        public final List<AssessmentControl> controls()

        The list of controls that's contained with the control set.

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

        Returns:
        The list of controls that's contained with the control set.
      • hasDelegations

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

        public final List<Delegation> delegations()

        The delegations that are associated with the control set.

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

        Returns:
        The delegations that are associated with the control set.
      • systemEvidenceCount

        public final Integer systemEvidenceCount()

        The total number of evidence objects that are retrieved automatically for the control set.

        Returns:
        The total number of evidence objects that are retrieved automatically for the control set.
      • manualEvidenceCount

        public final Integer manualEvidenceCount()

        The total number of evidence objects that are uploaded manually to the control set.

        Returns:
        The total number of evidence objects that are uploaded manually to the control set.
      • 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)