offapi/com/sun/star/document/XCmisDocument.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 module com {   module sun {   module star {   module document {
  11
  12 /** The document can provide access to CMIS properties and versions
  13     through this interface.
  14   */
  15 interface XCmisDocument : com::sun::star::uno::XInterface
  16 {
  17     /** Check out the document into a private working copy on the
  18         server, and update the loaded document to reflect this change.
  19      */
  20     void checkOut( );
  21
  22     /** Cancel checked out document, this will discard all changes since
  23         check-out.
  24      */
  25     void cancelCheckOut( );
  26
  27     /** Creates a new version of the document from the private working
  28         copy.
  29      */
  30     void checkIn( [in] boolean isMajor, [in] string comment );
  31
  32     /** Tells whether a document can support versioning or not.
  33      */
  34     boolean isVersionable( );
  35
  36     boolean canCheckOut( );
  37
  38     boolean canCancelCheckOut( );
  39
  40     boolean canCheckIn( );
  41
  42     void updateCmisProperties( [in] sequence <com::sun::star::document::CmisProperty> cmisProperties );
  43
  44     sequence <com::sun::star::document::CmisVersion> getAllVersions( );
  45
  46     /** Contains the properties values named after their CMIS ID.
  47      */
  48     [attribute] sequence <com::sun::star::document::CmisProperty> CmisProperties;
  49 };
  50
  51 }; }; }; };
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */