inc/FSecPrivilegeInfo.h

   1 //
   2 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
   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  * @file        FSecPrivilegeInfo.h
  19  * @brief       This is the header file for the %PrivilegeInfo class.
  20  *
  21  * This header file contains the declarations of the %PrivilegeInfo class.
  22  */
  23
  24 #ifndef _FSEC_PRIVILEGE_INFO_H_
  25 #define _FSEC_PRIVILEGE_INFO_H_
  26
  27 #include <FBaseObject.h>
  28
  29 namespace Tizen { namespace Security
  30 {
  31
  32 class _PrivilegeInfoImpl;
  33
  34 /**
  35 * @class        PrivilegeInfo
  36 * @brief        This class provides methods for managing the privilege information.
  37 *
  38 * @since        2.1
  39 *
  40 * @final        This class is not intended for extension.
  41 *
  42 * The %PrivilegeInfo class represents the privilege information.
  43 * This class provides methods to retrieve the name and description of privilege.
  44 *
  45 */
  46
  47 class _OSP_EXPORT_ PrivilegeInfo
  48         : public Tizen::Base::Object
  49 {
  50 public:
  51
  52         /**
  53          * The object is not fully constructed after this constructor is called. @n
  54          * For full construction, the Construct() method must be called right after calling this constructor.
  55          *
  56          * @since               2.1
  57          */
  58         PrivilegeInfo(void);
  59
  60         /**
  61          * This destructor overrides Tizen::Base::Object::~Object().
  62          *
  63          * @since 2.1
  64          *
  65          */
  66         virtual ~PrivilegeInfo(void);
  67
  68         /**
  69          * Initializes this instance of %PrivilegeInfo with the specified parameters.
  70          *
  71          * @since               2.1
  72          *
  73          * @return              An error code
  74          * @param[in]   privilegeId                             The privilege ID
  75          * @exception   E_SUCCESS                               The method is successful.
  76          * @exception   E_INVALID_ARG                   The specified @c privilegeId is invalid.
  77          *
  78          */
  79         result Construct(const Tizen::Base::String& privilegeId);
  80
  81         /**
  82          * Gets the privilege ID.
  83          *
  84          * @since               2.1
  85          *
  86          * @return              The privilege ID
  87          *
  88          */
  89         Tizen::Base::String GetId(void) const;
  90
  91         /**
  92          * Gets the localized display name of privilege.
  93          *
  94          * @since               2.1
  95          *
  96          * @return              The display name of privilege, @n
  97          *                              else an empty string is returned if there is no value
  98          *
  99          */
 100         Tizen::Base::String GetDisplayName(void) const;
 101
 102         /**
 103          * Gets the localized description of privilege.
 104          *
 105          * @since               2.1
 106          *
 107          * @return              The description of privilege, @n
 108          *                              else an empty string is returned if there is no value
 109          *
 110          */
 111         Tizen::Base::String GetDescription(void) const;
 112
 113 private:
 114
 115         //
 116         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 117         //
 118         // @param[in]   rhs             An instance of %PrivilegeInfo
 119         //
 120         PrivilegeInfo(const PrivilegeInfo& rhs);
 121
 122         //
 123         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 124         //
 125         // @param[in]   rhs             An instance of %PrivilegeInfo
 126         //
 127         PrivilegeInfo& operator =(const PrivilegeInfo& rhs);
 128
 129 private:
 130
 131         class _PrivilegeInfoImpl * __pImpl;
 132         friend class _PrivilegeInfoImpl;
 133
 134 }; // PrivilegeInfo
 135
 136 } } // Tizen::Security::PrivilegeInfo
 137
 138 #endif // _FSEC_PRIVILEGE_INFO_H_