<!--
* 
*
*  ProLinga-Doc
*
*  Copyright (C) 2002-2009 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_datasource">
  <refmeta>
    <refentrytitle>DataSource Object</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>DataSource</refname>
    <refpurpose>Source of the user data.</refpurpose>
  </refnamediv>

  <refsect1 id="obj_datasource_introduction">
    <title>Introduction</title>
    <para>
      Holds the information where the user data can be found.
    </para>
  </refsect1>

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

    <table frame='all' pgwide='1'>
      <title>DataSource 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 external data source.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>UserName</entry>
            <entry>User name defined for the connection.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>Password</entry>
            <entry>Password for defined user.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>ReadOnlyConnection</entry>
            <entry>Is data read-only?</entry>
            <entry>True, False</entry>
            <entry>False</entry>
          </row>
          <row>
            <entry>SqlIdentifiersCaseSensitive</entry>
            <entry>Let SQL identifiers submitted as input keep their sensitivity?</entry>
            <entry>True, False</entry>
            <entry>False</entry>
          </row>
          <row>
            <entry>ThreadSafe</entry>
            <entry>Will the connection be used by several threads at once?</entry>
            <entry>True, False</entry>
            <entry>True</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_datasource_example">
    <title>Example</title>
<programlisting><![CDATA[
<Object Application="MyOrder" Type="DataSource" Name="Customer">
  <DataSource>
     <ExternalName>order</ExternalName>
     <UserName>order_user</UserName>
     <Password></Password>
     <ReadOnlyConnection>False</ReadOnlyConnection>
     <SqlIdentifiersCaseSensitive>False</SqlIdentifiersCaseSensitive>
     <ThreadSafe>True</ThreadSafe>
     <Description>Customer</Description>
     <DetailDescription>Customer Table in PostgreSQL</DetailedDescription>
     <Modified>2009-07-27T23:26:29</Modified>
  </DataSource>
</Object>
]]></programlisting>
  </refsect1>

</refentry>

