include/framework/task/oma_dm_task_request.h

   1 /*
   2  * oma-dm-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef OMA_DM_TASK_ENABLE_H_
  19 #define OMA_DM_TASK_ENABLE_H_
  20
  21 /*dm-agent*/
  22 #include "common/dm_error.h"
  23 #include "common/dm_common.h"
  24 #include "framework/platform-event-handler/dm_platform_event_handler.h"
  25 #include "dm-engine/fumo/fumo_engine.h"
  26 #include "dm-engine/lawmo/lawmo_engine.h"
  27
  28 /**
  29  * @par Description: API to init dm task request
  30  *
  31  *
  32  * @par Purpose:
  33  * @par Typical use case:
  34  * @par Method of function operation:
  35  * @par Important notes:
  36  *
  37  * @return                              DM_OK                   success
  38  *                                                      DM_ERROR        fail
  39  *
  40  * @par Errors:
  41  *
  42  * @pre None.
  43  * @post
  44  * @see
  45  * @remarks None.
  46  *
  47  * @par Sample Code:
  48  * @code
  49  * @endcode
  50  */
  51 DM_ERROR dm_init_task_request();
  52
  53 /**
  54  * @par Description: API to reset dm task request
  55  *
  56  *
  57  * @par Purpose:
  58  * @par Typical use case:
  59  * @par Method of function operation:
  60  * @par Important notes:
  61  *
  62  * @return                              DM_OK                   success
  63  *                                                      DM_ERROR        fail
  64  *
  65  * @par Errors:
  66  *
  67  * @pre None.
  68  * @post
  69  * @see
  70  * @remarks None.
  71  *
  72  * @par Sample Code:
  73  * @code
  74  * @endcode
  75  */
  76 DM_ERROR dm_reset_task_request();
  77
  78 /**
  79  * @par Description: API to bootstrap task request
  80  *
  81  *
  82  * @par Purpose:
  83  * @par Typical use case:
  84  * @par Method of function operation:
  85  * @par Important notes:
  86  *
  87  * @return                              DM_OK                   success
  88  *                                                      DM_ERROR        fail
  89  *
  90  * @par Errors:
  91  *
  92  * @pre None.
  93  * @post
  94  * @see
  95  * @remarks None.
  96  *
  97  * @par Sample Code:
  98  * @code
  99  * @endcode
 100  */
 101 DM_ERROR bootstrap_task_request();
 102
 103 /**
 104  * @par Description: API to dm common task request
 105  *
 106  *
 107  * @par Purpose:
 108  * @par Typical use case:
 109  * @par Method of function operation:
 110  * @par Important notes:
 111  * @param[in]   event_data                                              Event_data
 112  *
 113  * @return                              DM_OK                   success
 114  *                                                      DM_ERROR        fail
 115  *
 116  * @par Errors:
 117  *
 118  * @pre None.
 119  * @post
 120  * @see
 121  * @remarks None.
 122  *
 123  * @par Sample Code:
 124  * @code
 125  * @endcode
 126  */
 127 DM_ERROR dm_fumo_common_task_request(Event_Contents * pEvent_data);
 128
 129 /**
 130  * @par Description: API to dm common task request
 131  *
 132  *
 133  * @par Purpose:
 134  * @par Typical use case:
 135  * @par Method of function operation:
 136  * @par Important notes:
 137  * @param[in]   event_data                                              Event_data
 138  *
 139  * @return                              DM_OK                   success
 140  *                                                      DM_ERROR        fail
 141  *
 142  * @par Errors:
 143  *
 144  * @pre None.
 145  * @post
 146  * @see
 147  * @remarks None.
 148  *
 149  * @par Sample Code:
 150  * @code
 151  * @endcode
 152  */
 153 DM_ERROR dm_fumo_ui_task_request(Event_Contents * pEvent_data);
 154
 155 /**
 156  * @par Description: API to dm common task request
 157  *
 158  *
 159  * @par Purpose:
 160  * @par Typical use case:
 161  * @par Method of function operation:
 162  * @par Important notes:
 163  * @param[in]   event_data                                              Event_data
 164  *
 165  * @return                              DM_OK                   success
 166  *                                                      DM_ERROR        fail
 167  *
 168  * @par Errors:
 169  *
 170  * @pre None.
 171  * @post
 172  * @see
 173  * @remarks None.
 174  *
 175  * @par Sample Code:
 176  * @code
 177  * @endcode
 178  */
 179 DM_ERROR dm_lawmo_common_task_request(Event_Contents * pEvent_data);
 180
 181 /**
 182  * @par Description: API to gemericalert task request
 183  *
 184  *
 185  * @par Purpose:
 186  * @par Typical use case:
 187  * @par Method of function operation:
 188  * @par Important notes:
 189  *
 190  * @return                              DM_OK                   success
 191  *                                                      DM_ERROR        fail
 192  *
 193  * @par Errors:
 194  *
 195  * @pre None.
 196  * @post
 197  * @see
 198  * @remarks None.
 199  *
 200  * @par Sample Code:
 201  * @code
 202  * @endcode
 203  */
 204 DM_ERROR genericAlert_task_request();
 205
 206 /**
 207  * @par Description: API to fumo serviceengine task request
 208  *
 209  *
 210  * @par Purpose:
 211  * @par Typical use case:
 212  * @par Method of function operation:
 213  * @par Important notes:
 214  *
 215  * @return                              DM_OK                   success
 216  *                                                      DM_ERROR        fail
 217  *
 218  * @par Errors:
 219  *
 220  * @pre None.
 221  * @post
 222  * @see
 223  * @remarks None.
 224  *
 225  * @par Sample Code:
 226  * @code
 227  * @endcode
 228  */
 229 DM_ERROR fumo_serviceEngine_task_request();
 230
 231 /**
 232  * @par Description: API to lawmo serviceengine task request
 233  *
 234  *
 235  * @par Purpose:
 236  * @par Typical use case:
 237  * @par Method of function operation:
 238  * @par Important notes:
 239  *
 240  * @return                              DM_OK                   success
 241  *                                                      DM_ERROR        fail
 242  *
 243  * @par Errors:
 244  *
 245  * @pre None.
 246  * @post
 247  * @see
 248  * @remarks None.
 249  *
 250  * @par Sample Code:
 251  * @code
 252  * @endcode
 253  */
 254 DM_ERROR lawmo_serviceEngine_task_request();
 255
 256 /**
 257  * @par Description: API to service engine task request
 258  *
 259  *
 260  * @par Purpose:
 261  * @par Typical use case:
 262  * @par Method of function operation:
 263  * @par Important notes:
 264  * @param[in]   Reminder_Interval                       Reminder Interval
 265  *
 266  * @return                              DM_OK                   success
 267  *                                                      DM_ERROR        fail
 268  *
 269  * @par Errors:
 270  *
 271  * @pre None.
 272  * @post
 273  * @see
 274  * @remarks None.
 275  *
 276  * @par Sample Code:
 277  * @code
 278  * @endcode
 279  */
 280 DM_ERROR fumo_schedule_task_request(Reminder_Interval remider_interval_type);
 281
 282 /**
 283  * @par Description: API to cancel task
 284  *
 285  *
 286  * @par Purpose:
 287  * @par Typical use case:
 288  * @par Method of function operation:
 289  * @par Important notes:
 290  * @param[in]   task id
 291  *
 292  * @return                              DM_OK                   success
 293  *                                                      DM_ERROR        fail
 294  *
 295  * @par Errors:
 296  *
 297  * @pre None.
 298  * @post
 299  * @see
 300  * @remarks None.
 301  *
 302  * @par Sample Code:
 303  * @code
 304  * @endcode
 305  */
 306 void cancel_task(int task_id);
 307
 308 #endif                          /* OMA_DM_TASK_ENABLE_H_ */