xref: /aoo4110/main/offapi/com/sun/star/ucb/Lock.idl (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_Lock_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_Lock_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_LockEntry_idl__
27*b1cdbd2cSJim Jagielski#include <com/sun/star/ucb/LockEntry.idl>
28*b1cdbd2cSJim Jagielski#endif
29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_LockDepth_idl__
30*b1cdbd2cSJim Jagielski#include <com/sun/star/ucb/LockDepth.idl>
31*b1cdbd2cSJim Jagielski#endif
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski//=============================================================================
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb {
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski//=============================================================================
38*b1cdbd2cSJim Jagielski/** defines a lock.
39*b1cdbd2cSJim Jagielski*/
40*b1cdbd2cSJim Jagielskipublished struct Lock : LockEntry
41*b1cdbd2cSJim Jagielski{
42*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
43*b1cdbd2cSJim Jagielski	/** defines the lock's depth.
44*b1cdbd2cSJim Jagielski	*/
45*b1cdbd2cSJim Jagielski	LockDepth Depth;
46*b1cdbd2cSJim Jagielski
47*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
48*b1cdbd2cSJim Jagielski	/** the owner of the lock.
49*b1cdbd2cSJim Jagielski
50*b1cdbd2cSJim Jagielski		<p>This element providfes information sufficient for either directly
51*b1cdbd2cSJim Jagielski		contacting a principal (such as a telephone number or email URI), or
52*b1cdbd2cSJim Jagielski		for discovering the principal (such as the URL of a homepage) who
53*b1cdbd2cSJim Jagielski		owns the lock.
54*b1cdbd2cSJim Jagielski	*/
55*b1cdbd2cSJim Jagielski	any Owner;
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
58*b1cdbd2cSJim Jagielski	/** a timeout value for the lock.
59*b1cdbd2cSJim Jagielski
60*b1cdbd2cSJim Jagielski		<p>This element specifies the number of seconds between granting
61*b1cdbd2cSJim Jagielski		of the lock and the automatic removal of that lock. The value
62*b1cdbd2cSJim Jagielski		must not be greater than <code>2^32-1</code>. A value of <code>-1</code>
63*b1cdbd2cSJim Jagielski		stands for an infinit lock, that will never be removed automatically.
64*b1cdbd2cSJim Jagielski	*/
65*b1cdbd2cSJim Jagielski	hyper Timeout;
66*b1cdbd2cSJim Jagielski
67*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
68*b1cdbd2cSJim Jagielski	/** the lock tokens.
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski	    <p>Each lock token is a URI.
71*b1cdbd2cSJim Jagielski	*/
72*b1cdbd2cSJim Jagielski	sequence< string > LockTokens;
73*b1cdbd2cSJim Jagielski};
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski//=============================================================================
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski}; }; }; };
78*b1cdbd2cSJim Jagielski
79*b1cdbd2cSJim Jagielski#endif
80