offapi/com/sun/star/util/XTimeStamped.idl

   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
  28 #ifndef __com_sun_star_util_XTimeStamped_idl__
  29 #define __com_sun_star_util_XTimeStamped_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 module com { module sun { module star { module util {
  36
  37 //============================================================================
  38
  39 /**
  40   provides timestamp information for an object
  41   in the form of an arbitrary string.
  42
  43   <p> The format and meaning of the timestamp depends on the implementation.
  44      Services implementing this interface must document the meaning and
  45      format they use.
  46   </p>
  47
  48   <p> If the timestamp is unchanged between two calls, the
  49      associated object has not changed. Any properties beyond this,
  50      particularly the presence of a meaningful order between
  51      timestamps, depend on the implementation.
  52   </p>
  53
  54     @since OOo 1.1.2
  55   */
  56 published interface XTimeStamped : ::com::sun::star::uno::XInterface
  57 {
  58     //------------------------------------------------------------------------
  59
  60     /**
  61       returns the timestamp of the object.
  62
  63
  64       @return
  65         a <atom>string</atom> that represents a timestamp.
  66       */
  67     string getTimestamp() ;
  68
  69     //------------------------------------------------------------------------
  70 } ;
  71
  72 } ; } ; } ; } ;
  73 #endif