Skip to content

/AWS1/IF_BLD=>DESCRIBECODECOVERAGES()

About DescribeCodeCoverages

Retrieves one or more code coverage reports.

Method Signature

METHODS /AWS1/IF_BLD~DESCRIBECODECOVERAGES
  IMPORTING
    !IV_REPORTARN TYPE /AWS1/BLDNONEMPTYSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BLDSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BLDPAGESIZE OPTIONAL
    !IV_SORTORDER TYPE /AWS1/BLDSORTORDERTYPE OPTIONAL
    !IV_SORTBY TYPE /AWS1/BLDRPTCODECOVERAGESORT00 OPTIONAL
    !IV_MINLINECOVERAGEPERCENTAGE TYPE /AWS1/RT_DOUBLE_AS_STRING OPTIONAL
    !IV_MAXLINECOVERAGEPERCENTAGE TYPE /AWS1/RT_DOUBLE_AS_STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_blddsccodecoverages01
  RAISING
    /AWS1/CX_BLDINVALIDINPUTEX
    /AWS1/CX_BLDCLIENTEXC
    /AWS1/CX_BLDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_reportarn TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The ARN of the report for which test cases are returned.

Optional arguments:

iv_nexttoken TYPE /AWS1/BLDSTRING /AWS1/BLDSTRING

The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

iv_maxresults TYPE /AWS1/BLDPAGESIZE /AWS1/BLDPAGESIZE

The maximum number of results to return.

iv_sortorder TYPE /AWS1/BLDSORTORDERTYPE /AWS1/BLDSORTORDERTYPE

Specifies if the results are sorted in ascending or descending order.

iv_sortby TYPE /AWS1/BLDRPTCODECOVERAGESORT00 /AWS1/BLDRPTCODECOVERAGESORT00

Specifies how the results are sorted. Possible values are:

FILE_PATH

The results are sorted by file path.

LINE_COVERAGE_PERCENTAGE

The results are sorted by the percentage of lines that are covered.

iv_minlinecoveragepercentage TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The minimum line coverage percentage to report.

iv_maxlinecoveragepercentage TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The maximum line coverage percentage to report.

RETURNING

oo_output TYPE REF TO /aws1/cl_blddsccodecoverages01 /AWS1/CL_BLDDSCCODECOVERAGES01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describecodecoverages(
  iv_maxlinecoveragepercentage = |0.1|
  iv_maxresults = 123
  iv_minlinecoveragepercentage = |0.1|
  iv_nexttoken = |string|
  iv_reportarn = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_codecoverages( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptystring = lo_row_1->get_id( ).
      lv_nonemptystring = lo_row_1->get_reportarn( ).
      lv_nonemptystring = lo_row_1->get_filepath( ).
      lv_percentage = lo_row_1->get_linecoveragepercentage( ).
      lv_nonnegativeint = lo_row_1->get_linescovered( ).
      lv_nonnegativeint = lo_row_1->get_linesmissed( ).
      lv_percentage = lo_row_1->get_branchcoveragepercentage( ).
      lv_nonnegativeint = lo_row_1->get_branchescovered( ).
      lv_nonnegativeint = lo_row_1->get_branchesmissed( ).
      lv_timestamp = lo_row_1->get_expired( ).
    ENDIF.
  ENDLOOP.
ENDIF.