Package com.levelaccess.continuum
Class AccessibilityConcern
java.lang.Object
com.levelaccess.continuum.AccessibilityConcern
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.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A class that encapsulates remediation steps suggested by Access Engine for resolving an accessibility concern.static class
A class that encapsulates accessibility standards associated with best practices returned by AMP. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets a brief human-readable description of this accessibility concern.Gets the name of the best practice that corresponds to this accessibility concern.Gets the URL of the best practice page in AMP that corresponds to this accessibility concern.Gets the best practice ID that corresponds to this accessibility concern.Gets the set of accessibility standards associated with the best practice that corresponds to this accessibility concern, ordered alphabetically by name.Gets the source code of the offending HTML node (for web) or XML element (for mobile) of this accessibility concern.Gets the automatic Access Engine test ID that failed and produced this accessibility concern.Gets the remediation steps suggested by Access Engine for resolving this accessibility concern.Defines the mobile type associated with this accessibility concern, i.e.Gets whether or not this accessibility concern requires manual review, i.e.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.getPath()
Gets a CSS (for web) or XPath (for mobile) selector to the element with this accessibility concern.com.google.gson.JsonObject
Gets the raw JSON object from Access Engine that was originally used to build this accessibility concern.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.Defines the test context in which this accessibility concern was identified, i.e.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.void
setAttribute
(String attribute) void
setBestPracticeDescription
(String bestPracticeDescription) void
setBestPracticeDetailsUrl
(String bestPracticeDetailsUrl) void
setBestPracticeId
(Integer bestPracticeId) void
setBestPracticeStandards
(Set<AccessibilityConcern.Standard> bestPracticeStandards) void
setElement
(String element) void
setEngineTestId
(Integer engineTestId) void
setFixType
(AccessibilityConcern.FixType fixType) void
setMobileType
(Continuum.MobileType mobileType) void
setNeedsReview
(Boolean needsReview) void
setNoticeability
(Integer noticeability) void
void
setSeverity
(Integer severity) void
setTestContext
(Continuum.TestContext testContext) void
setTractability
(Integer tractability)
-
Constructor Details
-
AccessibilityConcern
public AccessibilityConcern()
-
-
Method Details
-
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
-
getEngineTestId
Gets the automatic Access Engine test ID that failed and produced this accessibility concern. Visit the URL returned bygetBestPracticeDetailsUrl()
for more information.- Returns:
- the automatic Access Engine test ID that failed and produced this accessibility concern
-
setEngineTestId
-
getAttribute
Gets a brief human-readable description of this accessibility concern. Visit the URL returned bygetBestPracticeDetailsUrl()
for more information.- Returns:
- a brief human-readable description of this accessibility concern
-
setAttribute
-
getBestPracticeId
Gets the best practice ID that corresponds to this accessibility concern. Visit the URL returned bygetBestPracticeDetailsUrl()
for more information.- Returns:
- the best practice ID that corresponds to this accessibility concern
-
setBestPracticeId
-
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
-
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
-
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 bygetBestPracticeDetailsUrl()
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) ifContinuum.getIncludePotentialAccessibilityConcerns()
returns true.- Returns:
- whether or not this accessibility concern requires manual review
-
setNeedsReview
-
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
-
getBestPracticeDescription
Gets the name of the best practice that corresponds to this accessibility concern. Visit the URL returned bygetBestPracticeDetailsUrl()
for more information.- Returns:
- the name of the best practice that corresponds to this accessibility concern
-
setBestPracticeDescription
-
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 bygetBestPracticeDetailsUrl()
for more information.- Returns:
- the severity of the best practice that corresponds to this accessibility concern
-
setSeverity
-
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 bygetBestPracticeDetailsUrl()
for more information.- Returns:
- the noticeability of the best practice that corresponds to this accessibility concern
-
setNoticeability
-
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 bygetBestPracticeDetailsUrl()
for more information.- Returns:
- the tractability of the best practice that corresponds to this accessibility concern
-
setTractability
-
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
-
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 bygetBestPracticeDetailsUrl()
for more information.- Returns:
- the set of accessibility standards associated with the best practice that corresponds to this accessibility concern
-
setBestPracticeStandards
-
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. ifgetTestContext()
is notContinuum.TestContext.NATIVEAPP
.- Returns:
- the mobile type associated with this accessibility concern, if applicable; null if this accessibility concern isn't from mobile
-
setMobileType
-
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
-