Page History

...

The NestedList class can be used to create structured list, allowing references to analyses and outputs to be organized into sections and sub-sections. The class is used to define the listOfPlannedAnalyses and, if needed, the listOfPlannedOutputs for the reporting event.

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

• level: indicates the level of the list item within the structured list. A value of 1 indicates that the list item is at the first, or top, level, a value of 2 indicates that the list item is at the second level, etc.
• order: indicates the order of the list item with respect to other list items at the same level.
• name: descriptive text to be displayed for the list item.

Each list item may also have an association with one of the following:

• One of the outputs defined for the reporting event, which is the instance of the Output class identified by the value of the list item's outputId attribute. The value of the outputId attribute must match the value of the id attribute for one of the outputs in the reporting event.
• One of the analyses defined for the reporting event, which is the instance of the Analysis class identified by the value of the list item's analysisId attribute. The value of the analysisId attribute must match the value of the id attribute for one of the outputs in the reporting event.
• A sublist of items, represented as another instance of the NestedList class. If a list item has a sublist, the value of the level attribute for items in the sublist should be 1 greater than the list item's level.