xref: /trunk/main/offapi/com/sun/star/util/RevisionTag.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_util_RevisionTag_idl__
28#define __com_sun_star_util_RevisionTag_idl__
29
30#include <com/sun/star/util/DateTime.idl>
31
32//=============================================================================
33
34module com {  module sun {  module star {  module util {
35
36//=============================================================================
37
38/** represents the information that describes a revision of something, f.e. a document
39 */
40struct RevisionTag
41{
42	//-------------------------------------------------------------------------
43    /** contains the time when the revision was created ( can be invalid )
44	 */
45    DateTime    TimeStamp;
46
47	//-------------------------------------------------------------------------
48    /** contains an identifier for the author that created the revision( can be empty )
49	 */
50    string      Author;
51
52	//-------------------------------------------------------------------------
53    /** contains a comment that the author has left for this revision ( can be empty )
54	 */
55    string      Comment;
56
57	//-------------------------------------------------------------------------
58    /** contains a unique identifier for the revision and must not be empty
59        <p>
60        This identifier can have any form. It can be something like "1.2.3" or "Version 1" etc.
61        It depends on the revision control system how it names the revisions.
62        </p>
63	 */
64    string      Identifier;
65};
66
67//=============================================================================
68
69}; }; }; };
70
71#endif
72