<!--
* 
*
*  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_table">
  <refmeta>
    <refentrytitle>Table Object</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>Table</refname>
    <refpurpose>Collection of records and indices.</refpurpose>
  </refnamediv>

  <refsect1 id="obj_table_introduction">
    <title>Introduction</title>
    <para>
      Holds a collection of records and indices describing the table layout.
    </para>
  </refsect1>

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

    <table frame='all' pgwide='1'>
      <title>Table 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>ExternalName</entry>
            <entry>Name of the table within the 3rd party data provider.</entry>
            <entry>*</entry>
            <entry><replaceable>name</replaceable></entry>
          </row>
          <row>
            <entry>DataInterfaceType</entry>
            <entry>Type of the data interface.</entry>
            <entry>GDA, Repository</entry>
            <entry>GDA</entry>
          </row>
          <row>
            <entry>DataSourceName</entry>
            <entry>Name of the data source to use.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <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>OccurrencesTableRecordEntry</entry>
            <entry>

              <table frame='all' pgwide='1'>
                <title>Occurrences TableRecordEntry</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>RecordName</entry>
                      <entry>Name of the Record.</entry>
                      <entry>*</entry>
                      <entry>-</entry>
                    </row>
                    <row>
                      <entry>Reiterate</entry>
                      <entry>If the record can iterate. (for repository access only)</entry>
                      <entry>True, False</entry>
                      <entry>False</entry>
                    </row>
                    <row>
                      <entry>Default</entry>
                      <entry>If this is the default record.</entry>
                      <entry>True, False</entry>
                      <entry>True (for first entry)</entry>
                    </row>
                  </tbody>
                </tgroup>
              </table>

            </entry>
            <entry></entry>
            <entry></entry>
          </row>
          <row>
            <entry>OccurrencesTableIndexEntry</entry>
            <entry>

              <table frame='all' pgwide='1'>
                <title>Occurrences TableIndexEntry</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>IndexName</entry>
                      <entry>Name of the index.</entry>
                      <entry>*</entry>
                      <entry>-</entry>
                    </row>
                    <row>
                      <entry>Primary</entry>
                      <entry>If the index is the primary.</entry>
                      <entry>True, False</entry>
                      <entry>True (for first entry)</entry>
                    </row>
                    <row>
                      <entry>Unique</entry>
                      <entry>If the index is unique.</entry>
                      <entry>True, False</entry>
                      <entry>True</entry>
                    </row>
                    <row>
                      <entry>Sort</entry>
                      <entry>Sorting of the index. (At retrieval time only)</entry>
                      <entry>Ascending, Descending</entry>
                      <entry>Ascending</entry>
                    </row>
                  </tbody>
                </tgroup>
              </table>

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

  </refsect1>

  <refsect1 id="obj_table_example">
    <title>Example</title>
<programlisting><![CDATA[
<Object Application="MyOrder" Type="Table" Name="Country">
  <Table>
    <ExternalName>Country</ExternalName>
    <DataSourceName>Order</DataSourceName>
    <Description>Country</Description>
    <DetailDescription>Table of countries and codes</DetailDescription>
    <Modified>2007-11-12T09:58:00</Modified>
    <OccurencesTableRecordEntry>
      <TableRecordEntry>
        <RecordName>Country</RecordName>
        <Reiterate>False</Reiterate>
        <Default>True</Default>
      </TableRecordEntry>
    </OccurencesTableRecordEntry>
    <OccurencesTableIndexEntry>
      <TableIndexEntry>
        <IndexName>CountryCode</IndexName>
        <Primary>True</Primary>
        <Unique>True</Unique>
        <Sort>Ascending</Sort>
      </TableIndexEntry>
      <TableIndexEntry>
        <IndexName>Country</IndexName>
        <Primary>False</Primary>
        <Unique>False</Unique>
        <Sort>Ascending</Sort>
      </TableIndexEntry>
    </OccurencesTableIndexEntry>
  </Table>
</Object>
]]></programlisting>
  </refsect1>

</refentry>

