summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/document/XCmisDocument.idl
blob: 0f6ef8f6e9338b94a759900f7c06232aae732b17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef __com_sun_star_document_XCmisDocument_idl__
#define __com_sun_star_document_XCmisDocument_idl__

#include <com/sun/star/document/CmisProperty.idl>
#include <com/sun/star/document/CmisVersion.idl>
#include <com/sun/star/uno/XInterface.idl>

module com {   module sun {   module star {   module document {

/** The document can provide access to CMIS properties and versions
    through this interface.
  */
interface XCmisDocument : com::sun::star::uno::XInterface
{
    /** Check out the document into a private working copy on the
        server, and update the loaded document to reflect this change.
     */
    void checkOut( );

    /** Cancel checked out document, this will discard all changes since
        check-out.
     */
    void cancelCheckOut( );

    /** Creates a new version of the document from the private working
        copy.
     */
    void checkIn( [in] boolean isMajor, [in] string comment );

    /** Tells whether a document can support versioning or not.
     */
    boolean isVersionable( );

    boolean canCheckOut( );

    boolean canCancelCheckOut( );

    boolean canCheckIn( );

    void updateCmisProperties( [in] sequence <com::sun::star::document::CmisProperty> cmisProperties );

    sequence <com::sun::star::document::CmisVersion> getAllVersions( );

    /** Contains the properties values named after their CMIS ID.
     */
    [attribute] sequence <com::sun::star::document::CmisProperty> CmisProperties;
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */