Basic Eligibility/Entitlement example XML output

Here is an example of an XML document for a particular change date, produced by the AbstractBasicProductDecisionDetailsRuleSet.AbstractBasicCase rule class included with the Engine (to display basic eligibility/entitlement details):

<DecisionDetails>
  <BasicCase>
    <isEligibleTimeline domain="SVR_BOOLEAN">true</isEligibleTimeline>
    <displayObjectiveTimelines>
      <Item>
        <relatedReferenceTimeline domain="SVR_UNBOUNDED_STRING" />
        <index domain="SVR_INT64">0</index>
        <objectiveTypeID
           domain="SVR_UNBOUNDED_STRING">CREOLE 1</objectiveTypeID>
        <targetIDTimeline domain="SVR_INT64">123</targetIDTimeline>
        <isEntitledTimeline
           domain="SVR_BOOLEAN">true</isEntitledTimeline>
      </Item>
    </displayObjectiveTimelines>
    <displayObjectiveTimelineSubscreens>
      <Item>
        <displayTagTimelines>
          <Item>
            <pattern domain="FREQUENCY_PATTERN">000120100</pattern>
            <valueTimeline
               domain="SVR_UNBOUNDED_STRING">0</valueTimeline>
          </Item>
        </displayTagTimelines>
        <businessObjectID domain="SVR_INT64">0</businessObjectID>
      </Item>
    </displayObjectiveTimelineSubscreens>
  </BasicCase>
</DecisionDetails>

The XML has the following structure:

• A top-level DecisionDetails element; this is a fixed-named element provided by the Engine;
• A BasicCase element; the name of this element is that of a rule class used to provide decision details rules (in this example, for the "basic" objectives/tags output); this element represents a BasicCase rule object and the child elements represent the point-in-time values for attribute values from the rule object (for attributes which have been annotated with Display, to command them to be recorded in this XML);
• A isEligibleTimeline element for the value of the BasicCase. isEligibleTimeline timeline during this coverage period (in this case "true"); also specifies the domain type of the value so that the dynamic UIM understands the type of the data and can display or process it appropriately.
  Note: The domain type is automatically provided by the Engine by inspecting the data type of the rule attribute; usually this is sufficient but in some data conversion scenarios, you may explicitly specify the domain to use within the Display annotation.
• A displayObjectiveTimelines element for another attribute on BasicCase which is annotated with Display. This attribute returns a list of rule objects, and so this XML element has a child Item element (because in this example the list holds a single rule object - there will be one Item child element for each entry in the list value).
• The child elements of Item correspond to the attributes of the rule object in the displayObjectiveTimelines list value (in this case, attributes on the AbstractBasicProductDecisionDetailsRuleSet.DisplayObjectiveTimeline rule class)
• A displayObjectiveTimelineSubscreens element for an attribute on BasicCase which is annotated with DisplaySubscreen. This data will be used to allow the user to expand a row on the screen to drill down its detail by displaying a sub-screen of a data, keyed on the businessObjectID of the required item.