/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_ucb_Lock_idl__ #define __com_sun_star_ucb_Lock_idl__ #ifndef __com_sun_star_ucb_LockEntry_idl__ #include <com/sun/star/ucb/LockEntry.idl> #endif #ifndef __com_sun_star_ucb_LockDepth_idl__ #include <com/sun/star/ucb/LockDepth.idl> #endif //============================================================================= module com { module sun { module star { module ucb { //============================================================================= /** defines a lock. */ published struct Lock : LockEntry { //------------------------------------------------------------------------- /** defines the lock's depth. */ LockDepth Depth; //------------------------------------------------------------------------- /** the owner of the lock. <p>This element providfes information sufficient for either directly contacting a principal (such as a telephone number or email URI), or for discovering the principal (such as the URL of a homepage) who owns the lock. */ any Owner; //------------------------------------------------------------------------- /** a timeout value for the lock. <p>This element specifies the number of seconds between granting of the lock and the automatic removal of that lock. The value must not be greater than <code>2^32-1</code>. A value of <code>-1</code> stands for an infinite lock, that will never be removed automatically. */ hyper Timeout; //------------------------------------------------------------------------- /** the lock tokens. <p>Each lock token is a URI. */ sequence< string > LockTokens; }; //============================================================================= }; }; }; }; #endif