<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-checkin">
 <refnamediv>
  <refname>hw_api->checkin</refname>
  <refpurpose>Checks in an object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>hw_api</classname></ooclass>
   <methodsynopsis>
    <type>bool</type><methodname>checkin</methodname>
    <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   This function checks in an object or a whole hierarchy of objects.
   The parameters array contains the required element
   'objectIdentifier' and the optional element 'version', 'comment', 'mode'
   and
   'objectQuery'. 'version' sets the version of the object. It consists of
   the major and minor version separated by a period. If the version is not
   set, the minor version is incremented. 'mode' can be one of the following
   values:
   <variablelist>
    <varlistentry>
     <term>HW_API_CHECKIN_NORMAL</term>
     <listitem>
      <simpara>
       Checks in and commits the object. The object must be a document.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>HW_API_CHECKIN_RECURSIVE</term>
     <listitem>
      <simpara>
       If the object to check in is a collection, all children will be
       checked in recursively if they are documents. Trying to check in
       a collection would result in an error.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>HW_API_CHECKIN_FORCE_VERSION_CONTROL</term>
     <listitem>
      <simpara>
       Checks in an object even if it is not under version control.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>HW_API_CHECKIN_REVERT_IF_NOT_CHANGED</term>
     <listitem>
      <simpara>
       Check if the new version is different from the last version. Unless
       this is the case the object will be checked in.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>HW_API_CHECKIN_KEEP_TIME_MODIFIED</term>
     <listitem>
      <simpara>
       Keeps the time modified from the most recent object.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>HW_API_CHECKIN_NO_AUTO_COMMIT</term>
     <listitem>
      <simpara>
       The object is not automatically committed on check-in.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parameter</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="function.hwapi-checkout" /></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->