include/dm-engine/lawmo/lawmo_engine.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 LAWMO_ENGINE_H_
  19 #define LAWMO_ENGINE_H_
  20
  21 /*dm-agent*/
  22 #include "common/dm_error.h"
  23 #include "dm-engine/lawmo/lawmo_engine_internal.h"
  24
  25 /**
  26  * @par Description: API to execute lawmo operation
  27  *
  28  *
  29  * @par Purpose:
  30  * @par Typical use case:
  31  * @par Method of function operation:
  32  * @par Important notes:
  33  * @param[in]   full_path                                       mo full path
  34  * @param[in]   value                                                   value
  35  * @param[in]   check operation                 check operation
  36  *
  37  * @return                      DM_OK                                                   success
  38  *                                      DM_ERRORS                                       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 lawmo_exec(char *full_path, char *correlator, LAWMO_Result_code * lawmo_return, int check_operation);
  52
  53 /**
  54  * @par Description: API to execute lawmo operation
  55  *
  56  *
  57  * @par Purpose:
  58  * @par Typical use case:
  59  * @par Method of function operation:
  60  * @par Important notes:
  61  * @param[in]   full_path                                       mo full path
  62  * @param[out]  lawmo state data        lawmo state data
  63  *
  64  * @return                      DM_OK                                                   success
  65  *                                      DM_ERRORS                                       fail
  66  *
  67  * @par Errors:
  68  *
  69  * @pre None.
  70  * @post
  71  * @see
  72  * @remarks None.
  73  *
  74  * @par Sample Code:
  75  * @code
  76  * @endcode
  77  */
  78 DM_ERROR get_current_lawmo_state(char *full_path, char **lawmo_state_data);
  79
  80 /**
  81  * @par Description: API to execute lawmo operation
  82  *
  83  *
  84  * @par Purpose:
  85  * @par Typical use case:
  86  * @par Method of function operation:
  87  * @par Important notes:
  88  * @param[in]   full_path                                       mo full path
  89  * @param[in]   lawmo state                             lawmo state
  90  *
  91  * @return                      DM_OK                                                   success
  92  *                                      DM_ERRORS                                       fail
  93  *
  94  * @par Errors:
  95  *
  96  * @pre None.
  97  * @post
  98  * @see
  99  * @remarks None.
 100  *
 101  * @par Sample Code:
 102  * @code
 103  * @endcode
 104  */
 105 DM_ERROR set_current_lawmo_state(char *full_path, LAWMO_State lawmo_state);
 106
 107 #endif                          /* LAWMO_ENGINE_H_ */