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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTimeStamped.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_util_XTimeStamped_idl__
  32 #define __com_sun_star_util_XTimeStamped_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module util {
  39
  40 //============================================================================
  41
  42 /**
  43   provides timestamp information for an object
  44   in the form of an arbitrary string.
  45
  46   <p> The format and meaning of the timestamp depends on the implementation.
  47      Services implementing this interface must document the meaning and
  48      format they use.
  49   </p>
  50
  51   <p> If the timestamp is unchanged between two calls, the
  52      associated object has not changed. Any properties beyond this,
  53      particularly the presence of a meaningful order between
  54      timestamps, depend on the implementation.
  55   </p>
  56
  57     @since OOo 1.1.2
  58   */
  59 published interface XTimeStamped : ::com::sun::star::uno::XInterface
  60 {
  61     //------------------------------------------------------------------------
  62
  63     /**
  64       returns the timestamp of the object.
  65
  66
  67       @return
  68         a <atom>string</atom> that represents a timestamp.
  69       */
  70     string getTimestamp() ;
  71
  72     //------------------------------------------------------------------------
  73 } ;
  74
  75 } ; } ; } ; } ;
  76 #endif