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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_util_XTimeStamped_idl__
  21 #define __com_sun_star_util_XTimeStamped_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com { module sun { module star { module util {
  26
  27
  28 /**
  29   provides timestamp information for an object
  30   in the form of an arbitrary string.
  31
  32   <p> The format and meaning of the timestamp depends on the implementation.
  33      Services implementing this interface must document the meaning and
  34      format they use.
  35   </p>
  36
  37   <p> If the timestamp is unchanged between two calls, the
  38      associated object has not changed. Any properties beyond this,
  39      particularly the presence of a meaningful order between
  40      timestamps, depend on the implementation.
  41   </p>
  42
  43     @since OOo 1.1.2
  44   */
  45 published interface XTimeStamped : ::com::sun::star::uno::XInterface
  46 {
  47
  48     /**
  49       returns the timestamp of the object.
  50
  51
  52       @return
  53         a `string` that represents a timestamp.
  54       */
  55     string getTimestamp() ;
  56
  57 } ;
  58
  59 } ; } ; } ; } ;
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */