service/things-manager/sdk/java/jni/tm/inc/jni_capability.h

   1 /******************************************************************
   2  *
   3  * Copyright 2015 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  ******************************************************************/
  20
  21 /**
  22   * @file   jni_capability.h
  23   *
  24   * @brief  This file contains the utility functions for conversions from java to CPP
  25   * and viceversa
  26   */
  27
  28 #ifndef __JNI_CAPABILITY_H_
  29 #define __JNI_CAPABILITY_H_
  30
  31
  32 #include <string>
  33
  34 #include <ActionSet.h>
  35 #include "jni_object.h"
  36
  37 /**
  38  * @class   JniCapability
  39  * @brief   This class provides a set of functions to get and set Capability Class member variables
  40  *
  41  */
  42 class JniCapability : public JObject
  43 {
  44     public:
  45         /**
  46          * @brief constructor
  47          */
  48         JniCapability(JNIEnv *env, jobject obj);
  49
  50         /**
  51          * @brief constructor
  52          */
  53         JniCapability(JNIEnv *env);
  54
  55         /**
  56          * @brief destructor
  57          *
  58          */
  59         ~JniCapability();
  60
  61         /**
  62          * Retrieves Capability value from JniCapability class object
  63          *
  64          * @param   capability
  65          *              [OUT] capability value
  66          *
  67          * @return  Boolean, true on success, otherwise false
  68          *
  69          */
  70         bool getJniCapabilityValue(std::string &capability);
  71
  72         /**
  73          * Sets Capability value of JniCapability class object
  74          *
  75          * @param   capability
  76          *              [IN] capability value
  77          *
  78          * @return  Boolean, true on success, otherwise false
  79          *
  80          */
  81         bool setJniCapabilityValue(const std::string capability);
  82
  83         /**
  84          * Retrieves status of JniCapability class object
  85          *
  86          * @param   status
  87          *              [OUT] status
  88          *
  89          * @return  Boolean, true on success, otherwise false
  90          *
  91          */
  92         bool getJniCapabilityStatus(std::string &status);
  93
  94         /**
  95          * Sets status of JniCapability class object
  96          *
  97          * @param   status
  98          *              [IN] status
  99          *
 100          * @return  Boolean, true on success, otherwise false
 101          *
 102          */
 103         bool setJniCapabilityStatus(const std::string status);
 104 };
 105 #endif  //__JNI_CAPABILITY_H_