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

  <refnamediv>
    <refname>DataDictionary</refname>
    <refpurpose>Data of data items.</refpurpose>
  </refnamediv>

  <refsect1 id="obj_datadictionary_introduction">
    <title>Introduction</title>
    <para>
      Holds the data of the data items used in the application.
    </para>
  </refsect1>

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

    <table frame='all' pgwide='1'>
      <title>DataDictionary 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>External name of the dictionary in a RDBMS for instance.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>MaximumLength</entry>
            <entry>Maximum number of input characters.</entry>
            <entry>0-99999</entry>
            <entry>1</entry>
          </row>
          <row>
            <entry>MinimumLength</entry>
            <entry>Minimum number of input characters.</entry>
            <entry>0-99999</entry>
            <entry>1</entry>
          </row>
          <row>
            <entry>ArrayLength</entry>
            <entry>Number of instances.</entry>
            <entry>0-255</entry>
            <entry>1</entry>
          </row>
          <row>
            <entry>DataType</entry>
            <entry>Type of the data.</entry>
            <entry>String, Signed Decimal, Unsigned Decimal, DateTime, Boolean</entry>
            <entry>String</entry>
          </row>
          <row>
            <entry>ExternalStorageType</entry>
            <entry>Storage type in 3rd party (relational) database.</entry>
            <entry>Character, Integer, Long Integer, Single Precision Number, Double Precision Number</entry>
            <entry>Character</entry>
          </row>
          <row>
            <entry>DecimalPlaces</entry>
            <entry>Number of Decimal Places if DataType is Decimal.</entry>
            <entry>0-99</entry>
            <entry>0</entry>
          </row>
          <row>
            <entry>DateTimeFormat</entry>
            <entry>DateTimeFormat if type is DateTime.</entry>
            <entry><replaceable>blank</replaceable>, dd/mm/ccyy, mm/dd/ccyy, ccyy/mm/dd, hh:mm, hh:mm:ss, dd-mm-ccyyThh:mm:ss</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>MinimumValue</entry>
            <entry>Minimum possible value.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>MaximumValue</entry>
            <entry>Maximum possible value.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>PickList</entry>
            <entry>Name of a  pick list containing valid choices.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>Justification</entry>
            <entry>Alignment of data.</entry>
            <entry>Left, Right, Center</entry>
            <entry>Left</entry>
          </row>
          <row>
            <entry>PadCharacter</entry>
            <entry>Character used for padding.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>BlankWhenZero</entry>
            <entry>Display a zero when no item has no value.</entry>
            <entry>True, False</entry>
            <entry>False</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>
        </tbody>
      </tgroup>
    </table>

  </refsect1>

  <refsect1 id="obj_datadictionary_example">
    <title>Example</title>
<programlisting><![CDATA[
<Object Application="MyOrder" Type="DataDictionary" Name="Country">
  <DataDictionary>
     <ExternalName>Country</ExternalName>
     <MaximumLength>30</MaximumLength>
     <MinimumLength>0</MinimumLength>
     <ArrayLength>1</ArrayLength>
     <DataType>String</DataType>
     <ExternalStorageType></ExternalStorageType>
     <DecimalPlaces>0</DecimalPlaces>
     <DateTimeFormat></DateTimeFormat>
     <MinimumValue></MinimumValue>
     <MaximumValue></MaximumValue>
     <PickList>CountryList</PickList>
     <Justification>Left</Justification>
     <PadCharacter></PadCharacter>
     <BlankWhenZero>True</BlankWhenZero>
     <Description>Country Name</Description>
     <DetailDescription>Name of country</DetailDescription>
     <Modified>2007-11-12T09:58:00</Modified>
  </DataDictionary>
</Object>
]]></programlisting>
  </refsect1>

</refentry>

