summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/Lock.idl
blob: f27ee84dec3d3def13ec55f988cd358d37886e73 (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
62
63
64
65
66
/* -*- 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_ucb_Lock_idl__
#define __com_sun_star_ucb_Lock_idl__

#include <com/sun/star/ucb/LockEntry.idl>
#include <com/sun/star/ucb/LockDepth.idl>


module com { module sun { module star { module ucb {

/** defines a lock.
*/
published struct Lock : LockEntry
{
    /** defines the lock's depth.
    */
    LockDepth Depth;

    /** the owner of the lock.

        <p>This element provides information sufficient for either directly
        contacting a principal (such as a telephone number or email URI), or
        for discovering the principal (such as the URL of a homepage) who
        owns the lock.
    */
    any Owner;

    /** a timeout value for the lock.

        <p>This element specifies the number of seconds between granting
        of the lock and the automatic removal of that lock. The value
        must not be greater than <code>2^32-1</code>. A value of <code>-1</code>
        stands for an infinite lock, that will never be removed automatically.
    */
    hyper Timeout;

    /** the lock tokens.

        <p>Each lock token is a URI.
    */
    sequence< string > LockTokens;
};


}; }; }; };

#endif

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