MAPGROUPARRAY
Retrieves a list of Map value(s) based on parameter criteria.
| TYPE=MAPGROUPARRAY | ||||
|---|---|---|---|---|
| Element | Attributes | Parent Element | Description | Element/Attribute Value |
|
<MathVariable> |
|
|
||
|
VARIABLENAME |
Required |
Literal string |
||
|
TYPE |
Required Identifies the type of the MathVariable. |
MAPGROUPARRAY | ||
|
DATATYPE |
Required |
DECIMAL, INTEGER, TEXT, DATE |
||
|
ROUND |
Optional when DATATYPE="DECIMAL" |
Integer | ||
|
DEFAULT |
Optional |
String | ||
|
LOG |
Optional |
YES, NO [Default=NO] |
||
|
STARTINDEX |
Optional The starting index of the map group array. The Math Variable should contain an Integer value. |
Integer, Literal |
||
|
ENDINDEX |
Optional The ending index of the map group array. The Math Variable should contain an Integer value. |
Integer, Literal |
||
|
<Parameters> |
|
<MathVariable> |
Required |
|
|
<MapGroupDescription> |
|
<Parameters> |
Required This is the MAPGROUPDESCRIPTION from AsMapGroup, for the table to use to retrieve Map Values. The datatype for the Math Variable should be Text. (Like CurrCOITableName, Freelookdays Map Groups) |
Math Variable, LITERAL |
|
<MapCriteria> |
|
<Parameters> |
Required, Repeatable The MathVariable previously defined that holds the value of the Criteria (Like 20 for Term Years). The datatype for the Math Variable must match the datatype of the Criteria in the AsMapCriteria table. |
|
|
|
NAME |
<MapCriteria> |
Required The specific instance of Criteria given in AsMapCriteria (The actual instance such as TermYears, StateCode etc. ) The Name attribute specifies the name of the Map Criteria. |
Math Variable, LITERAL |
XML Schema
<!-- TYPE="MAPGROUPARRAY" -->
<!-- ROUND="[Integer]" is an optional attribute to be used when DATATYPE="DECIMAL" -->
<!-- DEFAULT="[String]" is an optional attribute -->
<!-- LOG="YES" is an optional attribute -->
<!-- -->
<MathVariable VARIABLENAME="[String]" TYPE="MAPGROUPARRAY" DATATYPE="DECIMAL" STARTINDEX="[Integer]" ENDINDEX="[Integer]" ROUND="[Integer]" DEFAULT="[String]" LOG="Yes">
<Parameters>
<MapDescription>[String]</MapDescription>
<!-- there can be 1-to-n occurrences of the "MapCriteria" tag -->
<MapCriteria>[String]</MapCriteria>
</Parameters>
</MathVariable>
XML Example
<MathVariable VARIABLENAME="MapGroupArrayMV" TYPE="MAPGROUPARRAY" STARTINDEX="20" ENDINDEX="30" DATATYPE="DECIMAL">
<Parameters>
<MapGroupDescription>MapGroupDescriptionMV</MapGroupDescription>
<MapCriteria NAME="TermYears">TermYearsMV</MapCriteria>
<MapCriteria NAME="RateActiveDate">RateActiveDateMV</MapCriteria>
<MapCriteria NAME="PLANGUID">PLANGUIDMV</MapCriteria>
<MapCriteria NAME="StateAbbreviation">StateAbbreviationMV</MapCriteria>
<MapCriteria NAME="StateCode">StateCodeMV</MapCriteria>
<MapCriteria NAME="SegmentTypeCode">SegmentTypeCodeMV</MapCriteria>
<MapCriteria NAME="ROPExist">ROPExistMV</MapCriteria>
<MapCriteria NAME="LowFace">LowFaceMV</MapCriteria>
<MapCriteria NAME="HighFace">HighFaceMV</MapCriteria>
</Parameters>
</MathVariable>
