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