Class: ListOfContents

The ListOfContents class can be used to create structured lists, allowing references to analyses and outputs to be organized into sections and subsections. The class is used to define the mainListOfContents and, if needed, additional otherListsOfContents for the reporting event.

An instance of the ListOfContents class is created for each list of contents and, in each instance:

The NestedList class has only 1 attribute, listItems, which is a set of 1 or more list items. Each list item is represented as an instance of the OrderedListItem class and has the following attributes:

Each list item may also have an association with 1 or more of the following:

As the ARS Model does not currently contain any direct link between analyses and the outputs that display the results of the analyses, it is recommended that the mainListOfContents is used to indicate the relationship between outputs and analyses. If an outputId is specified on a list item, it is implied that the output identified by the outputId value contains results of any analysis whose id value is found as an analysisId value on the same list item as the outputId, or on any list item within a sublist that stems from the list item with the outputId.

In the previous example:

  • The output identified as "O_T2" would contain results from the analysis referenced on the first level 2 list item ("A_SAF_SUM_USUBJID_TRT"), as well as results from each of the analyses referenced on the 3 list items with level = 3 ("A_SAF_SUM_USUBJID_TRT_SEX", "A_SAF_SUM_AGE_TRT", and "A_SAF_SUM_USUBJID_TRT_AGEGRP").
  • The output identified as "O_T3" would contain results from the analysis identified as "A_SAF_SUM_BLCLCHRX_TRT".