inc/FTelISimStateManagerGetPinLockSettingResultListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-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        FTelISimStateManagerGetPinLockSettingResultListener.h
  20  * @brief       This is the header file for the %ISimStateManagerGetPinLockSettingResultListener interface.
  21  *
  22  * This header file contains the declarations of the %ISimStateManagerGetPinLockSettingResultListener interface.
  23  *
  24  */
  25 #ifndef _FTEL_ISIM_STATE_MANAGER_GET_PIN_LOCK_SETTING_RESULT_LISTENER_H_
  26 #define _FTEL_ISIM_STATE_MANAGER_GET_PIN_LOCK_SETTING_RESULT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29
  30
  31 namespace Tizen { namespace Telephony
  32 {
  33 /**
  34  * @interface   ISimStateManagerGetPinLockSettingResultListener
  35  * @brief               This interface provides methods to receive the result of the SimStateManager::GetPinLockSetting() asynchronous method.
  36  *
  37  * @since               2.1
  38  *
  39  * The %ISimStateManagerGetPinLockSettingResultListener interface provides methods to receive the result of the SimStateManager::GetPinLockSetting() asynchronous method.
  40  *
  41  */
  42 class _OSP_EXPORT_ ISimStateManagerGetPinLockSettingResultListener
  43         : virtual public Tizen::Base::Runtime::IEventListener
  44 {
  45 public:
  46         /**
  47          * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  48          *
  49          * @since       2.1
  50          */
  51         virtual ~ISimStateManagerGetPinLockSettingResultListener(void) {}
  52
  53 public:
  54         /**
  55          * Called when a response to the PIN lock setting query is received.
  56          *
  57          * @since               2.1
  58          *
  59          * @param[in]   isEnabled               The PIN lock setting value
  60          * @param[in]   r                               The result of the request @n The following exceptions may be given through this parameter.
  61          *
  62          * @exception   E_SUCCESS               The method is successful.
  63          * @exception   E_INVALID_STATE         The SIM is in an invalid state.
  64          */
  65         virtual void OnSimStateManagerGetPinLockSettingResultReceived(bool isEnabled, result r) = 0;
  66
  67 }; // ISimStateManagerGetPinLockSettingResultListener
  68
  69 } } // Tizen::Telephony
  70
  71 #endif // _FTEL_ISIM_STATE_MANAGER_GET_PIN_LOCK_SETTING_RESULT_LISTENER_H_