Page History

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

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

• The name attribute indicates the name of the list of contents.
• The description attribute may be used to record a detailed description of the list of contents including, for example, its purpose.
• The label attribute may be used to record a short description of the list of contents.
• The contentsList attribute contains the specification of the list of contents, represented as an instance of the NestedList

...

• class.

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:

• 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, and so on.
• 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
• description: May be used to record a detailed description of the list item.
• label: May be used to record a short alternative description of the list item.

Each list item may also have an association with 1 or more 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 1 of the outputs in the reporting event. See the Output section for more information about output definitions.
• 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 1 of the analyses in the reporting event. See the Analysis section for more information about analysis definitions.
• 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.

...