Lists of Values

LOV defines the list of values associated with the parameter. It describes the possible values of the answer.

The <lov> element defines a list of values itself.

<lov hierarchical="true|false" partial="true|false" refreshable="true|false" searchable="true|false" 
    path="[[0|1|2,\ second_level_value],[0|1|2,\ third_level_value],[...]]">

The following table describes the <lov> attributes.

Attribute Description
hierarchical Specifies whether the list of values associated with the parameter is hierarchical.
partial Specifies whether the list of values is displayed entirely. The size of the list of values depends on server settings or universe query limit.
refreshable Specifies whether the list of values can be refreshed. This attribute can be used in a user interface to allow the refresh of the list of values.
searchable Specifies whether values of the list of values can be searched. This attribute can be used in a user interface to allow the search on a list of values.
path Optional. In the case of hierarchical parameters, specifies the values and types of the hierarchy, starting with the second level. This attribute only appears in the lov element of the XML stream returned by the PUT .../parameters call.

The syntax [0|1|2,\ value] describes the data type and the data value of a level.

  • 0 represents a string
  • 1 represents a date
  • 2 represents a number

See path attribute example in Example - Responding to a Hierarchical Parameter.

One Column

LOV is made of the following elements if the list of values contains one column:

<lov hierarchical="true|false" partial="true|false" refreshable="true|false" searchable="true|false"
    path="[...]"> 
    <id>An identifier</id>
    <updated>A date</updated>
    [Intervals|Values]
     Columns
</lov>
Note Columns does not appear if the parameter is of type context.

The following <lov> children describe a list of values:

Child Element Description
<id> The list of values identifier as a string
<updated> The date of last update of the list of values
Intervals The element block that describes values as intervals when the number of values is too large. The first interval is returned by default. An interval can contain 50 values.
<intervals>
    <interval id="Integer">
        <value id="Integer" final="true|false"></value>
        <value id="Integer" final="true|false"></value>
    </interval>
    ...
<intervals>
Values The element block that describes the possible values of the list of values
<values>
    <value id="Integer" final="true|false"></value>
    ...
</value>
Columns The element block that describes the column to be mapped to the list of values. <column> defines the column name. Its type attribute is mandatory.
<columns mappingID="Integer">
    <column id="Integer" type="String|Date|Numeric"></column> 
</columns>
Multiple Columns

LOV is made of the following elements if the list of values contains multiple columns:

<lov hierarchical="true|false" partial="true|false" refreshable="true|false" searchable="true|false"
    path="[...]"> 
    <id>An identifier</id>
    <updated>A date</updated>
    [Intervals_MC|Values_MC]
     Columns
</lov>
Note Columns does not appear if the parameter is of type context.

The following <lov> children describe a list of values:

Child Element Description
<id> The list of values identifier as a string
<updated> The date of last update of the list of values
Intervals_MC The element block that describes values as intervals when the number of values is too large. The first interval is returned by default. An interval can contain 50 values.
<intervals>
    <interval id="Integer">
        <cvalue id="Integer" final="true|false">
            <column id="Integer" type="String|Date|Numeric"></column>
            ...
        </cvalue>
        <cvalue id="Integer" final="true|false">
            <column id="Integer" type="String|Date|Numeric"></column>
            ...
        </cvalue>
    </interval>
    ...
<intervals>
Values_MC The element block that describes the possible values of the list of values. <cvalue> defines the values of multiple columns. <column> defines the column value.
<cvalues>
    <cvalue id="Integer" final="true|false">
        <column id="Integer" type="String|Date|Numeric"></column>
        ...
    </cvalue>
    ...
<cvalues>
Columns The element block that describes the columns to be mapped to the list of values. <column> defines the column name. Its type attribute is mandatory. mappingID defines the identifier of the column, of which the value is used as reference to answer the parameter.
<columns mappingID="Integer">
    <column id="Integer" type="String|Date|Numeric"></column>
    ... 
</columns>
Cascading Parameters

In the case of cascading parameters, the value given to a parameter depends on the answer to a previous parameter.

LOV is made of the following elements:

<lov hierarchical="true|false" partial="true|false" refreshable="true|false" searchable="true|false"
    path="[...]"> 
    <id>An identifier</id>
    <parameters>
        <id>An identifier</id>
        <id>An identifier</id>
        ...
    </parameters>    
</lov>

Under <parameters>, each <id> corresponds to the identifier of a parameter, on which depend the values of the current parameter.