inc/FSclIRecordListener.h

   1 //
   2 // Copyright (c) 2012 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  * @file        FSclIRecordListener.h
  18  * @brief       This is the header file for the %IRecordListener interface.
  19  *
  20  * This header file contains the declarations of the %IRecordListener interface.
  21  */
  22 #ifndef _FSCL_IRECORD_LISTENER_H_
  23 #define _FSCL_IRECORD_LISTENER_H_
  24
  25 #include <FBaseRtIEventListener.h>
  26 #include <FBaseDataType.h>
  27
  28 namespace Tizen { namespace Base { namespace Collection
  29 {
  30 class IList;
  31 }}}
  32
  33 namespace Tizen { namespace Social
  34 {
  35
  36 /**
  37  * @if OSPDEPREC
  38  * @interface   IRecordListener
  39  * @brief               <i> [Deprecated] </i> This interface represents a listener to asynchronously retrieve the records from the Calendarbook or Addressbook.
  40  *
  41  * @deprecated          This interface is deprecated because the @ref Calendarbook::GetEventInstances method is deprecated.
  42  *
  43  * @since       2.0
  44  *
  45  * The %IRecordListener interface represents a listener to asynchronously retrieve the records from the Calendarbook or Addressbook.
  46  * @endif
  47  */
  48 class _OSP_EXPORT_ IRecordListener
  49         : virtual public Tizen::Base::Runtime::IEventListener
  50 {
  51 public:
  52
  53         /**
  54          * @if OSPDEPREC
  55          * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
  56          * are called when the destructor of this interface is called.
  57          *
  58          * @brief               <i> [Deprecated] </i>
  59          * @deprecated          This method is deprecated because the %IRecordListener interface is deprecated.
  60          *
  61          * @since       2.0
  62          * @endif
  63          */
  64         virtual ~IRecordListener(void) {}
  65
  66         /**
  67          * @if OSPDEPREC
  68          * Called when the requested records are retrieved.
  69          *
  70          * @brief               <i> [Deprecated] </i>
  71          * @deprecated          This method is deprecated because the %IRecordListener interface is deprecated.
  72          *
  73          * @since       2.0
  74          *
  75          * @param[in]   reqId                           The request ID
  76          * @param[in]   pRecords                        The result of a specific asynchronous method @n
  77          *                                                                      A list containing all of the retrieved Record instances, @n
  78          *                                                                      else an empty list if there are no retrieved records, or @c null if an exception occurs
  79          * @param[in]   r                                       The result of the request
  80          * @exception   E_SUCCESS                       The request is successful.
  81          * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.
  82          * @remarks             After using @c pRecords, the application must delete it.
  83          * @see                 Calendarbook::GetEventInstances()
  84          * @endif
  85          */
  86         virtual void OnRecordsReceivedN(RequestId reqId, Tizen::Base::Collection::IList* pRecords, result r) = 0;
  87
  88 protected:
  89
  90         //
  91         // This method is for internal use only. Using this method can cause behavioral, security-related,
  92         // and consistency-related issues in the application.
  93         // This method is reserved and may change its name at any time without prior notice.
  94         //
  95         // @since       2.0
  96         //
  97         virtual void IRecordListener_Reserved1(void) { }
  98
  99         //
 100         // This method is for internal use only. Using this method can cause behavioral, security-related,
 101         // and consistency-related issues in the application.
 102         // This method is reserved and may change its name at any time without prior notice.
 103         //
 104         // @since       2.0
 105         //
 106         virtual void IRecordListener_Reserved2(void) { }
 107
 108 };      // IRecordListener
 109
 110 }}      // Tizen::Social
 111
 112 #endif // _FSCL_IRECORD_LISTENER_H_