/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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 infinit lock, that will never be removed automatically.
    */
    hyper Timeout;

    //-------------------------------------------------------------------------
    /** the lock tokens.

        <p>Each lock token is a URI.
    */
    sequence< string > LockTokens;
};

//=============================================================================

}; }; }; };

#endif
