offapi/com/sun/star/ucb/Lock.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_Lock_idl__
  28 #define __com_sun_star_ucb_Lock_idl__
  29
  30 #ifndef __com_sun_star_ucb_LockEntry_idl__
  31 #include <com/sun/star/ucb/LockEntry.idl>
  32 #endif
  33 #ifndef __com_sun_star_ucb_LockDepth_idl__
  34 #include <com/sun/star/ucb/LockDepth.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** defines a lock.
  43 */
  44 published struct Lock : LockEntry
  45 {
  46     //-------------------------------------------------------------------------
  47     /** defines the lock's depth.
  48     */
  49     LockDepth Depth;
  50
  51     //-------------------------------------------------------------------------
  52     /** the owner of the lock.
  53
  54         <p>This element providfes information sufficient for either directly
  55         contacting a principal (such as a telephone number or email URI), or
  56         for discovering the principal (such as the URL of a homepage) who
  57         owns the lock.
  58     */
  59     any Owner;
  60
  61     //-------------------------------------------------------------------------
  62     /** a timeout value for the lock.
  63
  64         <p>This element specifies the number of seconds between granting
  65         of the lock and the automatic removal of that lock. The value
  66         must not be greater than <code>2^32-1</code>. A value of <code>-1</code>
  67         stands for an infinit lock, that will never be removed automatically.
  68     */
  69     hyper Timeout;
  70
  71     //-------------------------------------------------------------------------
  72     /** the lock tokens.
  73
  74         <p>Each lock token is a URI.
  75     */
  76     sequence< string > LockTokens;
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif