inc/FSecPrivilegeInfo.h

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