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

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