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 #ifndef __com_sun_star_document_XCmisDocument_idl__
  10 #define __com_sun_star_document_XCmisDocument_idl__
  11
  12 #include <com/sun/star/document/CmisProperty.idl>
  13 #include <com/sun/star/document/CmisVersion.idl>
  14 #include <com/sun/star/uno/XInterface.idl>
  15
  16 module com {   module sun {   module star {   module document {
  17
  18 /** The document can provide access to CMIS properties and versions
  19     through this interface.
  20   */
  21 interface XCmisDocument : com::sun::star::uno::XInterface
  22 {
  23     /** Check out the document into a private working copy on the
  24         server, and update the loaded document to reflect this change.
  25      */
  26     void checkOut( );
  27
  28     /** Cancel checked out document, this will discard all changes since
  29         check-out.
  30      */
  31     void cancelCheckOut( );
  32
  33     /** Creates a new version of the document from the private working
  34         copy.
  35      */
  36     void checkIn( [in] boolean isMajor, [in] string comment );
  37
  38     /** Tells whether a document can support versioning or not.
  39      */
  40     boolean isVersionable( );
  41
  42     boolean canCheckOut( );
  43
  44     boolean canCancelCheckOut( );
  45
  46     boolean canCheckIn( );
  47
  48     void updateCmisProperties( [in] sequence <com::sun::star::document::CmisProperty> cmisProperties );
  49
  50     sequence <com::sun::star::document::CmisVersion> getAllVersions( );
  51
  52     /** Contains the properties values named after their CMIS ID.
  53      */
  54     [attribute] sequence <com::sun::star::document::CmisProperty> CmisProperties;
  55 };
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */