xref: /trunk/main/offapi/com/sun/star/util/XTimeStamped.idl (revision 34c958ab)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_util_XTimeStamped_idl__
#define __com_sun_star_util_XTimeStamped_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com { module sun { module star { module util {

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

/**
  provides timestamp information for an object
  in the form of an arbitrary string.

  <p> The format and meaning of the timestamp depends on the implementation.
     Services implementing this interface must document the meaning and
     format they use.
  </p>

  <p> If the timestamp is unchanged between two calls, the
     associated object has not changed. Any properties beyond this,
     particularly the presence of a meaningful order between
     timestamps, depend on the implementation.
  </p>

    @since OpenOffice 1.1.2
  */
published interface XTimeStamped : ::com::sun::star::uno::XInterface
{
    //------------------------------------------------------------------------

    /**
      returns the timestamp of the object.


      @return
        a <atom>string</atom> that represents a timestamp.
      */
    string getTimestamp() ;

    //------------------------------------------------------------------------
} ;

} ; } ; } ; } ;
#endif