offapi/com/sun/star/ucb/Lock.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_Lock_idl__
  20 #define __com_sun_star_ucb_Lock_idl__
  21
  22 #include <com/sun/star/ucb/LockEntry.idl>
  23 #include <com/sun/star/ucb/LockDepth.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** defines a lock.
  29 */
  30 published struct Lock : LockEntry
  31 {
  32     /** defines the lock's depth.
  33     */
  34     LockDepth Depth;
  35
  36     /** the owner of the lock.
  37
  38         <p>This element provides information sufficient for either directly
  39         contacting a principal (such as a telephone number or email URI), or
  40         for discovering the principal (such as the URL of a homepage) who
  41         owns the lock.
  42     */
  43     any Owner;
  44
  45     /** a timeout value for the lock.
  46
  47         <p>This element specifies the number of seconds between granting
  48         of the lock and the automatic removal of that lock. The value
  49         must not be greater than <code>2^32-1</code>. A value of <code>-1</code>
  50         stands for an infinite lock, that will never be removed automatically.
  51     */
  52     hyper Timeout;
  53
  54     /** the lock tokens.
  55
  56         <p>Each lock token is a URI.
  57     */
  58     sequence< string > LockTokens;
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */