com.levelaccess.continuum

Enum AMPReportingService.ReportManagementStrategy

java.lang.Object

java.lang.Enum<AMPReportingService.ReportManagementStrategy>

com.levelaccess.continuum.AMPReportingService.ReportManagementStrategy

All Implemented Interfaces:

Serializable, Comparable<AMPReportingService.ReportManagementStrategy>

Enclosing class:

AMPReportingService

public static enum AMPReportingService.ReportManagementStrategy
extends Enum<AMPReportingService.ReportManagementStrategy>

Defines supported strategies with which to create new reports and edit existing ones. Choosing the correct report management strategy to meet your business objectives is critical to using Continuum's AMP reporting functionality correctly, so please consult our support documentation for more information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND Append any new modules to a report, creating the report first if it doesn't already exist; do not overwrite any existing reports.
OVERWRITE Overwrite existing reports when a report with the same ID or name already exists, deleting any existing modules in the report in AMP prior to repopulating it with any new modules.
UNIQUE Always create new reports, guaranteeing uniqueness by appending the current date and time as an ISO 8601 timestamp to the end of each report's name; do not overwrite or append modules to any existing reports.

Method Summary

Modifier and Type	Method and Description
static AMPReportingService.ReportManagementStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static AMPReportingService.ReportManagementStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APPEND

public static final AMPReportingService.ReportManagementStrategy APPEND

Append any new modules to a report, creating the report first if it doesn't already exist; do not overwrite any existing reports. Useful for intentionally adding to an existing report, e.g. one that was just created recently, rather than creating a new report.

OVERWRITE

public static final AMPReportingService.ReportManagementStrategy OVERWRITE

Overwrite existing reports when a report with the same ID or name already exists, deleting any existing modules in the report in AMP prior to repopulating it with any new modules. This is the recommended strategy for a more manual report generation workflow, e.g. when a developer is creating new reports from their own workstation, or when there is otherwise little reason to retain old reports. While using this report management strategy, make sure to specify active modules by name (via AMPReportingService.setActiveModule(String, String)) rather than by ID (via AMPReportingService.setActiveModule(Integer)); any modules in the active report (including the active module, assuming it's in the active report) will be deleted from AMP next time AMPReportingService.submitAccessibilityConcernsToAMP(List) is invoked, making the active module ID invalid before any test results can be submitted to the module in AMP it used to reference, which will cause Continuum to throw a NotFoundException.

UNIQUE

public static final AMPReportingService.ReportManagementStrategy UNIQUE

Always create new reports, guaranteeing uniqueness by appending the current date and time as an ISO 8601 timestamp to the end of each report's name; do not overwrite or append modules to any existing reports. This is the recommended strategy for a continuous integration (CI) workflow, i.e. for a report generation process that's automatically performed periodically, or when you otherwise don't wish to overwrite any previous reports for record keeping purposes.

Method Detail

valueOf

public static AMPReportingService.ReportManagementStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

public static AMPReportingService.ReportManagementStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AMPReportingService.ReportManagementStrategy c : AMPReportingService.ReportManagementStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared