src/modules/API/DEPRACATED/System/IDate.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /**
  17  * @author       Zbigniew Kostrzewa (z.kostrzewa@samsung.com)
  18  */
  19
  20 #ifndef WRTPLUGINS_SYSTEM_IDATE_H_
  21 #define WRTPLUGINS_SYSTEM_IDATE_H_
  22
  23 #include <string>
  24 #include <dpl/shared_ptr.h>
  25
  26 namespace WrtPlugins {
  27 namespace Api {
  28 namespace System {
  29 /**
  30  * Date class.
  31  * Creating an Date object with default (parameterless) ctor makes object
  32  * with current date/time values.
  33  */
  34 class IDate
  35 {
  36   public:
  37     /**
  38      * Represents format for date to string conversions.
  39      */
  40     typedef std::string Format;
  41
  42   public:
  43     virtual ~IDate() = 0;
  44
  45     /**
  46      * Gets date converted to string using default format.
  47      * @return Date string.
  48      */
  49     virtual std::string toString() const = 0;
  50
  51     /**
  52      * Gets date converted to string using specified format.
  53      * @param format Format.
  54      * @return Date string.
  55      */
  56     virtual std::string toString(const Format& format) const = 0;
  57 };
  58
  59 typedef DPL::SharedPtr<IDate> IDatePtr;
  60 } // System
  61 } // Api
  62 } // WrtPlugins
  63
  64 #endif // WRTPLUGINS_SYSTEM_IDATE_H_