inc/FSclIRecordListener.h

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