javaextensions/pim/cntadapter/inc.s60/cpimcontactlistadapter.h
branchRCL_3
changeset 83 26b2b12093af
parent 77 7cee158cb8cd
equal deleted inserted replaced
77:7cee158cb8cd 83:26b2b12093af
   193      * list adapter may then release all resources it has reserved.
   193      * list adapter may then release all resources it has reserved.
   194      * No method of the list adapter can be invoked after call to Close.
   194      * No method of the list adapter can be invoked after call to Close.
   195      */
   195      */
   196     void Close();
   196     void Close();
   197 
   197 
   198     void CPIMContactListAdapter::DoClose();
   198     void DoClose();
   199 
   199 
   200 public: // MPIMContactListAdapter
   200 public: // MPIMContactListAdapter
   201 
   201 
   202     /**
   202     /**
   203      * Provides access to the \ref MPIMListAdapter representation of this
   203      * Provides access to the \ref MPIMListAdapter representation of this
   221      * The method leaves on error. Such error always means that the list
   221      * The method leaves on error. Such error always means that the list
   222      * adapter is non-functional.
   222      * adapter is non-functional.
   223      */
   223      */
   224     void CreateContactItemL(MPIMContactItem& aContactItem);
   224     void CreateContactItemL(MPIMContactItem& aContactItem);
   225 
   225 
   226     void CPIMContactListAdapter::DoCreateContactItemL(
   226     void DoCreateContactItemL(MPIMContactItem& aContactItem);
   227         MPIMContactItem& aContactItem);
       
   228 
   227 
   229     /**
   228     /**
   230      * Reads an existing contact item from the native database.
   229      * Reads an existing contact item from the native database.
   231      * The adapter maps the Item ID in \a aContactItem to a native database
   230      * The adapter maps the Item ID in \a aContactItem to a native database
   232      * entry identifier, reads the entry and sets the data of
   231      * entry identifier, reads the entry and sets the data of
   247      *        native database.
   246      *        native database.
   248      * @li Other - The list adapter is non-functional.
   247      * @li Other - The list adapter is non-functional.
   249      */
   248      */
   250     void ReadContactItemL(MPIMContactItem& aContactItem);
   249     void ReadContactItemL(MPIMContactItem& aContactItem);
   251 
   250 
   252     void CPIMContactListAdapter::DoCallReadContactItemL(
   251     void DoCallReadContactItemL(MPIMContactItem& aContactItem);
   253         MPIMContactItem& aContactItem);
       
   254 
   252 
   255     /**
   253     /**
   256      * Reads an existing contact item from the native database
   254      * Reads an existing contact item from the native database
   257      * This version reads only minimal contact item data and should be used
   255      * This version reads only minimal contact item data and should be used
   258      * when listing contacts through the API. Contacts Model view definition
   256      * when listing contacts through the API. Contacts Model view definition
   269      *        be retrieved, although the Item ID of \a aContactItem is not
   267      *        be retrieved, although the Item ID of \a aContactItem is not
   270      *        \ref KPIMNullItemID. The entry is probably removed from the
   268      *        \ref KPIMNullItemID. The entry is probably removed from the
   271      *        native database.
   269      *        native database.
   272      * @li Other - The list adapter is non-functional.
   270      * @li Other - The list adapter is non-functional.
   273      */
   271      */
   274     void ReadMinimalContactItemL(
   272     void ReadMinimalContactItemL(MPIMContactItem& aContactItem);
   275         MPIMContactItem& aContactItem);
   273 
   276 
   274     void DoCallReadMinimalContactItemL(MPIMContactItem& aContactItem);
   277     void CPIMContactListAdapter::DoCallReadMinimalContactItemL(
       
   278         MPIMContactItem& aContactItem);
       
   279 
   275 
   280     /**
   276     /**
   281      * Reads an existing contact item from the native database
   277      * Reads an existing contact item from the native database
   282      * This version reads only minimal contact item data and should be used
   278      * This version reads only minimal contact item data and should be used
   283      * when listing contacts through the API. This version takes a matching
   279      * when listing contacts through the API. This version takes a matching
   313      *        from the database
   309      *        from the database
   314      */
   310      */
   315     void ReadContactFieldL(MPIMContactItem& aContactItem,
   311     void ReadContactFieldL(MPIMContactItem& aContactItem,
   316                            TPIMContactField aContactField);
   312                            TPIMContactField aContactField);
   317 
   313 
   318     void CPIMContactListAdapter::DoReadContactFieldL(
   314     void DoReadContactFieldL(
   319         MPIMContactItem& aContactItem,
   315         MPIMContactItem& aContactItem,
   320         TPIMContactField aContactField);
   316         TPIMContactField aContactField);
   321 
   317 
   322     /**
   318     /**
   323      * Writes an existing contact item to the native database.
   319      * Writes an existing contact item to the native database.
   341      *        client. The operation may succeed later.
   337      *        client. The operation may succeed later.
   342      * @li Other - The list adapter is non-functional.
   338      * @li Other - The list adapter is non-functional.
   343      */
   339      */
   344     void WriteContactItemL(MPIMContactItem& aContactItem);
   340     void WriteContactItemL(MPIMContactItem& aContactItem);
   345 
   341 
   346     void CPIMContactListAdapter::DoWriteContactItemL(
   342     void DoWriteContactItemL(MPIMContactItem& aContactItem);
   347         MPIMContactItem& aContactItem);
       
   348 
   343 
   349     /**
   344     /**
   350      * Removes an existing contact from the native database.
   345      * Removes an existing contact from the native database.
   351      * The adapter maps \a aItemID to a native database entry and removes
   346      * The adapter maps \a aItemID to a native database entry and removes
   352      * it.
   347      * it.
   413      *
   408      *
   414      * @param aContactItem PIM Contact item to which the data is read
   409      * @param aContactItem PIM Contact item to which the data is read
   415      * @param aContactItemViewDef View definition which is used for
   410      * @param aContactItemViewDef View definition which is used for
   416      *        reading the contact item from the database
   411      *        reading the contact item from the database
   417      */
   412      */
   418     void CPIMContactListAdapter::DoReadContactItemL(
   413     void DoReadContactItemL(
   419         MPIMContactItem& aContactItem,
   414         MPIMContactItem& aContactItem,
   420         const CContactItemViewDef& aContactItemViewDef);
   415         const CContactItemViewDef& aContactItemViewDef);
   421 
   416 
   422     void IsDatabaseReadyL();
   417     void IsDatabaseReadyL();
   423 
   418