Class AccessibilityConcern

java.lang.Object
com.levelaccess.continuum.AccessibilityConcern

public class AccessibilityConcern extends Object
This class represents an accessibility concern identified by Access Engine. At minimum, it contains both information about the concern that was identified and well as where on the page the problem is located. It may also include best practice data from AMP, e.g. how severe or noticeable the issue might be, along with an AMP URL that can be visited for more info.
  • Constructor Details

    • AccessibilityConcern

      public AccessibilityConcern()
  • Method Details

    • getPath

      public String getPath()
      Gets a CSS (for web) or XPath (for mobile) selector to the element with this accessibility concern.
      Returns:
      a CSS (for web) or XPath (for mobile) selector to the element with this accessibility concern
    • setPath

      public void setPath(String path)
    • getEngineTestId

      public Integer getEngineTestId()
      Gets the automatic Access Engine test ID that failed and produced this accessibility concern. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      the automatic Access Engine test ID that failed and produced this accessibility concern
    • setEngineTestId

      public void setEngineTestId(Integer engineTestId)
    • getAttribute

      public String getAttribute()
      Gets a brief human-readable description of this accessibility concern. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      a brief human-readable description of this accessibility concern
    • setAttribute

      public void setAttribute(String attribute)
    • getBestPracticeId

      public Integer getBestPracticeId()
      Gets the best practice ID that corresponds to this accessibility concern. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      the best practice ID that corresponds to this accessibility concern
    • setBestPracticeId

      public void setBestPracticeId(Integer bestPracticeId)
    • getElement

      public String getElement()
      Gets the source code of the offending HTML node (for web) or XML element (for mobile) of this accessibility concern. If the presence of an offending element is not applicable to this accessibility concern, this will be null.
      Returns:
      the source code of the offending HTML node (for web) or XML element (for mobile) of this accessibility concern
    • setElement

      public void setElement(String element)
    • getFixType

      public AccessibilityConcern.FixType getFixType()
      Gets the remediation steps suggested by Access Engine for resolving this accessibility concern.
      Returns:
      the remediation steps suggested by Access Engine for resolving this accessibility concern
    • setFixType

      public void setFixType(AccessibilityConcern.FixType fixType)
    • getNeedsReview

      public Boolean getNeedsReview()
      Gets whether or not this accessibility concern requires manual review, i.e. whether the user should manually use AMP to determine whether or not this accessibility concern is actually a legitimate violation given the context of the offending element (getElement()). If this returns true, visit the URL returned by getBestPracticeDetailsUrl() for more information on how to manually validate the applicability of this accessibility concern relative to the offending element (getElement()); it may be that this accessibility concern is not applicable given this context. Accessibility concerns that require manual review will only ever be returned (and thus this function will only ever possibly return false for a given accessibility concern) if Continuum.getIncludePotentialAccessibilityConcerns() returns true.
      Returns:
      whether or not this accessibility concern requires manual review
    • setNeedsReview

      public void setNeedsReview(Boolean needsReview)
    • getTestContext

      public Continuum.TestContext getTestContext()
      Defines the test context in which this accessibility concern was identified, i.e. whether the offending element of this accessibility concern (getElement()) is a native mobile (Android or iOS) component (Continuum.TestContext.NATIVEAPP) or an HTML element of web content rendered in a mobile app or otherwise from a web page (Continuum.TestContext.WEB).
      Returns:
      the test context in which this accessibility concern was identified
    • setTestContext

      public void setTestContext(Continuum.TestContext testContext)
    • getBestPracticeDescription

      public String getBestPracticeDescription()
      Gets the name of the best practice that corresponds to this accessibility concern. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      the name of the best practice that corresponds to this accessibility concern
    • setBestPracticeDescription

      public void setBestPracticeDescription(String bestPracticeDescription)
    • getSeverity

      public Integer getSeverity()
      Gets the severity of this accessibility concern on a scale of 1 to 10, where 1 is the least severe and 10 is the most severe. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      the severity of the best practice that corresponds to this accessibility concern
    • setSeverity

      public void setSeverity(Integer severity)
    • getNoticeability

      public Integer getNoticeability()
      Gets the noticeability of this accessibility concern on a scale of 1 to 10, where 1 is the least noticeable and 10 is the most noticeable. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      the noticeability of the best practice that corresponds to this accessibility concern
    • setNoticeability

      public void setNoticeability(Integer noticeability)
    • getTractability

      public Integer getTractability()
      Gets the tractability of this accessibility concern on a scale of 1 to 10, where 1 is the least tractable and 10 is the most tractable. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      the tractability of the best practice that corresponds to this accessibility concern
    • setTractability

      public void setTractability(Integer tractability)
    • getBestPracticeDetailsUrl

      public String getBestPracticeDetailsUrl()
      Gets the URL of the best practice page in AMP that corresponds to this accessibility concern. An AMP license is not required to visit this URL, but if you're logged into AMP, you'll be presented with additional information beyond what's publicly available.
      Returns:
      the URL of the best practice page in AMP that corresponds to this accessibility concern
    • setBestPracticeDetailsUrl

      public void setBestPracticeDetailsUrl(String bestPracticeDetailsUrl)
    • getBestPracticeStandards

      public Set<AccessibilityConcern.Standard> getBestPracticeStandards()
      Gets the set of accessibility standards associated with the best practice that corresponds to this accessibility concern, ordered alphabetically by name. Visit the URL returned by getBestPracticeDetailsUrl() for more information.
      Returns:
      the set of accessibility standards associated with the best practice that corresponds to this accessibility concern
    • setBestPracticeStandards

      public void setBestPracticeStandards(Set<AccessibilityConcern.Standard> bestPracticeStandards)
    • getMobileType

      public Continuum.MobileType getMobileType()
      Defines the mobile type associated with this accessibility concern, i.e. whether the offending element of this accessibility concern (getElement()) is from Android (Continuum.MobileType.ANDROID) or iOS (Continuum.MobileType.IOS). This will be null if this accessibility concern isn't from mobile, i.e. if getTestContext() is not Continuum.TestContext.NATIVEAPP.
      Returns:
      the mobile type associated with this accessibility concern, if applicable; null if this accessibility concern isn't from mobile
    • setMobileType

      public void setMobileType(Continuum.MobileType mobileType)
    • getRawEngineJsonObject

      public com.google.gson.JsonObject getRawEngineJsonObject()
      Gets the raw JSON object from Access Engine that was originally used to build this accessibility concern.
      Returns:
      the raw JSON object from Access Engine that was originally used to build this accessibility concern