<!--
* 
*
*  ProLinga-Doc
*
*  Copyright (C) 2002-2008 Xobas Software.
*  All rights reserved.
*  
*  This file is part of ProLinga-Doc.
*
*  ProLinga-Doc is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  ProLinga-Doc is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with ProLinga-Doc.  If not, see <http://www.gnu.org/licenses/>.
*
*  More information is available at the following addresses:
*
*  Website     : http://www.prolinga.org
*
*  Email       : prolinga-list@prolinga.org
*
*
-->
<refentry id="obj_variablegroup">
  <refmeta>
    <refentrytitle>VariableGroup Object</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VariableGroup</refname>
    <refpurpose>Collection of data dictionaries to hold data.</refpurpose>
  </refnamediv>

  <refsect1 id="obj_variablegroup_introduction">
    <title>Introduction</title>
    <para>
      Holds a collection of data dictionaries grouped together, which can be 
      used to store data in memory.
    </para>
  </refsect1>

  <refsect1 id="obj_variablegroup_properties">
    <title>Properties</title>

    <table frame='all' pgwide='1'>
      <title>Record Object Properties</title>
      <tgroup cols='4' align='left' colsep='1' rowsep='1'>
        <thead>
          <row>
            <entry>Name</entry>
            <entry>Details</entry>
            <entry>Possible Values</entry>
            <entry>Default Value</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>Description</entry>
            <entry>Description to be used in lists.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>DetailDescription</entry>
            <entry>Detailed description.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>Modified</entry>
            <entry>Modification date-time stamp in ISO 8601 format.</entry>
            <entry><replaceable>ccyy-mm-dd</replaceable>T<replaceable>hh:mm:ss</replaceable></entry>
            <entry><replaceable>date stamp</replaceable></entry>
          </row>
          <row>
            <entry>OccurrencesVariableEntry</entry>
            <entry>

              <table frame='all' pgwide='1'>
                <title>Occurrences VariableEntry</title>
                <tgroup cols='4' align='left' colsep='1' rowsep='1'>
                  <thead>
                    <row>
                      <entry>Name</entry>
                      <entry>Details</entry>
                      <entry>Possible Values</entry>
                      <entry>Default Value</entry>
                    </row>
                  </thead>
                  <tbody>
                    <row>
                      <entry>DataDictionaryName</entry>
                      <entry>Name of the DataDictionary.</entry>
                      <entry>*</entry>
                      <entry>-</entry>
                    </row>
                    <row>
                      <entry>InitialValue</entry>
                      <entry>Initial value of the Variable Group item.</entry>
                      <entry>*</entry>
                      <entry>-</entry>
                    </row>
                  </tbody>
                </tgroup>
              </table>

            </entry>
            <entry></entry>
            <entry></entry>
          </row>
        </tbody>
      </tgroup>
    </table>

  </refsect1>

  <refsect1 id="obj_variablegroup_example">
    <title>Example</title>
<programlisting><![CDATA[
<Object Application="MyOrder" Type="VariableGroup" Name="PrintSelection">
  <VariableGroup>
    <Description>Print Selection</Description>
    <DetailDescription>Selections before printing</DetailDescription>
    <Modified>2007-11-12T09:58:00</Modified>
    <OccurencesVariableEntry>
      <VariableEntry>
        <DataDictionaryName>OrderDateFrom</DataDictionaryName>
        <InitialValue>20071128</InitialValue>
      </VariableEntry>
      <VariableEntry>
        <DataDictionaryName>OrderDateTo</DataDictionaryName>
        <InitialValue>20071129</IntialValue>
      </VariableEntry>
    </OccurencesVariableEntry>
  </VariableGroup>
</Object>
]]></programlisting>
  </refsect1>

</refentry>

