service/things-manager/sdk/java/jni/tm/inc/jni_action.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_action.h
  23   *
  24   * @brief  This file contains the declaration of JniAction class and its members related to JniAction.
  25   */
  26
  27 #ifndef __JNI_ACTION_H_
  28 #define __JNI_ACTION_H_
  29
  30
  31 #include <vector>
  32 #include <string>
  33
  34 #include "jni_object.h"
  35 #include "jni_capability.h"
  36
  37 /**
  38  * @class   JniAction
  39  * @brief   This class provides a set of functions to get and set Action Class member variables
  40  *
  41  */
  42 class JniAction : public JObject
  43 {
  44     public:
  45         /**
  46          * @brief constructor
  47          */
  48         JniAction(JNIEnv *env, jobject obj);
  49
  50         /**
  51          * @brief constructor
  52          */
  53         JniAction(JNIEnv *env);
  54
  55         /**
  56          * @brief destructor
  57          *
  58          */
  59         ~JniAction();
  60
  61         /**
  62          * Retrieves target value from JniAction class object
  63          *
  64          * @param target - target value
  65          *
  66          * @return Boolean, true on success, otherwise false
  67          *
  68          */
  69         bool getTarget(std::string &target);
  70
  71         /**
  72          * Sets target value of JniAction class object
  73          *
  74          * @param target - target value
  75          *
  76          * @return Boolean, true on success, otherwise false
  77          *
  78          */
  79         bool setTarget(const std::string target);
  80
  81         /**
  82          * Retrieves capability values from JniAction class object
  83          *
  84          * @param capabilityList - capability list
  85          *
  86          * @return Boolean, true on success, otherwise false
  87          */
  88         bool getJniCapabilityValues(std::vector<OIC::Capability *> &capabilityList);
  89
  90 };
  91 #endif //__JNI_ACTION_H_