src/modules/API/Messaging/IMmsSlides.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  *
  18  *
  19  * @file       IMmsSlides.h
  20  * @author     Grzegorz Krawczyk (g.krawczyk@samsung.com)
  21  * @version    0.1
  22  * @brief
  23  */
  24
  25 #ifndef IMMS_SLIDES_H
  26 #define IMMS_SLIDES_H
  27
  28 #include <vector>
  29
  30 #include "IMmsSlide.h"
  31
  32 namespace WrtDeviceApis {
  33 namespace Messaging {
  34 namespace Api {
  35 class IMmsSlides
  36 {
  37   public:
  38
  39     virtual ~IMmsSlides()
  40     {
  41     }
  42
  43     /**
  44      * create empty slide
  45      * @return shared pointer to created IMmsSlide
  46      * */
  47     virtual IMmsSlidePtr createEmptySlide() const = 0;
  48
  49     /**
  50      * check data validity
  51      * @return true if slides are valid
  52      *      or false if one or more slide need update
  53      * */
  54     virtual bool checkSlidesValidity() const = 0;
  55
  56     /**
  57      * set data validity
  58      * */
  59     virtual void setSlidesValidity(bool state) = 0;
  60
  61     /**
  62      * set slides
  63      * */
  64     virtual void setSlides(const std::vector<IMmsSlidePtr>& slides) = 0;
  65
  66     /**
  67      * add slide to mms object
  68      * */
  69     virtual void addSlide(const IMmsSlidePtr& slide) = 0;
  70
  71     /**
  72      * get slide count
  73      * @return number of slides in mms
  74      * */
  75     virtual size_t getSlideCount() const = 0;
  76
  77     /**
  78      * get slide by number
  79      * @return shared pointer to IMmsSlide
  80      * @throw INVALID_ARGUMENT_EXCEPTION
  81      * if argument is wrong
  82      * */
  83     virtual IMmsSlidePtr getSlide(size_t nb) const = 0;
  84
  85     /**
  86      * get slides
  87      * @return vector of slides from Mms
  88      * */
  89     virtual std::vector<IMmsSlidePtr> getSlides() const = 0;
  90
  91     /**
  92      * replace slide
  93      * @throw INVALID_ARGUMENT_EXCEPTION
  94      * if argument is wrong
  95      * */
  96     virtual void replaceSlide(size_t pos,
  97             const IMmsSlidePtr& slide) = 0;
  98
  99     /**
 100      * remove slide
 101      * @throw INVALID_ARGUMENT_EXCEPTION
 102      * if argument is wrong
 103      * */
 104     virtual void removeSlide(size_t pos) = 0;
 105 };
 106 }
 107 }
 108 }
 109 #endif