include/common/common_define.h

   1 /*
   2  * oma-ds-agent
   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 /**
  19  *   @Common_Define.h
  20  *   @version                                                                   0.1
  21  *   @brief                                                                             This file is the header file of interface for common structure
  22  */
  23
  24 #ifndef COMMON_DEFINE_H_
  25 #define COMMON_DEFINE_H_
  26
  27 #include "common_define_internal.h"
  28
  29 /**
  30  * @par Description: API to create datastore_info_s structure
  31  *
  32  *
  33  * @par Purpose:
  34  * @par Typical use case:
  35  * @par Method of function operation:
  36  * @par Important notes:
  37  * @param[in]           string type, target uri
  38  * @param[in]           string type, source uri
  39  * @param[out]          Status structure
  40  *
  41  * @return                              datastore_info_s on success
  42  *                                                      NULL on error
  43  *
  44  * @par Errors:
  45  *
  46  * @pre None.
  47  * @post
  48  * @see
  49  * @remarks None.
  50  *
  51  * @par Sample Code:
  52  * @code
  53  * @endcode
  54  */
  55 datastore_info_s *create_datastore_info(char *target, char *source);
  56
  57 /**
  58  * @par Description: API to free list of datastore_info_s structure
  59  *
  60  *
  61  * @par Purpose:
  62  * @par Typical use case:
  63  * @par Method of function operation:
  64  * @par Important notes:
  65  * @param[in]           list of datastore_info_s structure
  66  * @param[out]
  67  *
  68  * @return
  69  *
  70  * @par Errors:
  71  *
  72  * @pre None.
  73  * @post
  74  * @see
  75  * @remarks None.
  76  *
  77  * @par Sample Code:
  78  * @code
  79  * @endcode
  80  */
  81 void free_datastore_infos(GList * datastore_infos);
  82
  83 /**
  84  * @par Description: API to free datastore_info_s structure
  85  *
  86  *
  87  * @par Purpose:
  88  * @par Typical use case:
  89  * @par Method of function operation:
  90  * @par Important notes:
  91  * @param[in]           datastore_info_s structure
  92  * @param[out]
  93  *
  94  * @return
  95  *
  96  * @par Errors:
  97  *
  98  * @pre None.
  99  * @post
 100  * @see
 101  * @remarks None.
 102  *
 103  * @par Sample Code:
 104  * @code
 105  * @endcode
 106  */
 107 void free_datastore_info(datastore_info_s * datastore_info);
 108
 109 /**
 110  * @par Description: API to set sync type in datastore_info_s structure
 111  *
 112  *
 113  * @par Purpose:
 114  * @par Typical use case:
 115  * @par Method of function operation:
 116  * @par Important notes:
 117  * @param[in]           datastore_info_s structure
 118  * @param[in]           enum type, sync type
 119  * @param[out]
 120  *
 121  * @return
 122  *
 123  * @par Errors:
 124  *
 125  * @pre None.
 126  * @post
 127  * @see
 128  * @remarks None.
 129  *
 130  * @par Sample Code:
 131  * @code
 132  * @endcode
 133  */
 134 void set_datastore_info_sync_type(datastore_info_s * datastore_info, alert_type_e sync_type);
 135
 136 /**
 137  * @par Description: API to set last anchor in datastore_info_s structure
 138  *
 139  *
 140  * @par Purpose:
 141  * @par Typical use case:
 142  * @par Method of function operation:
 143  * @par Important notes:
 144  * @param[in]           datastore_info_s structure
 145  * @param[in]           string type, last anchor
 146  * @param[out]
 147  *
 148  * @return
 149  *
 150  * @par Errors:
 151  *
 152  * @pre None.
 153  * @post
 154  * @see
 155  * @remarks None.
 156  *
 157  * @par Sample Code:
 158  * @code
 159  * @endcode
 160  */
 161 void set_datastore_info_last_anchor(datastore_info_s * datastore_info, char *last_anchor);
 162
 163 /**
 164  * @par Description: API to set next anchor in datastore_info_s structure
 165  *
 166  *
 167  * @par Purpose:
 168  * @par Typical use case:
 169  * @par Method of function operation:
 170  * @par Important notes:
 171  * @param[in]           datastore_info_s structure
 172  * @param[in]           string type, next anchor
 173  * @param[out]
 174  *
 175  * @return
 176  *
 177  * @par Errors:
 178  *
 179  * @pre None.
 180  * @post
 181  * @see
 182  * @remarks None.
 183  *
 184  * @par Sample Code:
 185  * @code
 186  * @endcode
 187  */
 188 void set_datastore_info_next_anchor(datastore_info_s * datastore_info, char *next_anchor);
 189
 190 /**
 191  * @par Description: API to set max_obj_size in datastore_info_s structure
 192  *
 193  *
 194  * @par Purpose:
 195  * @par Typical use case:
 196  * @par Method of function operation:
 197  * @par Important notes:
 198  * @param[in]           datastore_info_s structure
 199  * @param[in]           unsigned int, max_obj_size
 200  * @param[out]
 201  *
 202  * @return
 203  *
 204  * @par Errors:
 205  *
 206  * @pre None.
 207  * @post
 208  * @see
 209  * @remarks None.
 210  *
 211  * @par Sample Code:
 212  * @code
 213  * @endcode
 214  */
 215 void set_datastore_info_max_obj_size(datastore_info_s * datastore_info, unsigned int max_obj_size);
 216
 217 /**
 218  * @par Description: API to create changed_item_s structure
 219  *
 220  *
 221  * @par Purpose:
 222  * @par Typical use case:
 223  * @par Method of function operation:
 224  * @par Important notes:
 225  * @param[in]           enum type, change type of item
 226  * @param[in]           string type, luid of item
 227  * @param[out]
 228  *
 229  * @return                              changed_item_s on success
 230  *                                                      NULL on error
 231  *
 232  * @par Errors:
 233  *
 234  * @pre None.
 235  * @post
 236  * @see
 237  * @remarks None.
 238  *
 239  * @par Sample Code:
 240  * @code
 241  * @endcode
 242  */
 243 changed_item_s *create_changed_item(change_type_e type, char *luid);
 244
 245 /**
 246  * @par Description: API to free changed_item_s structure
 247  *
 248  *
 249  * @par Purpose:
 250  * @par Typical use case:
 251  * @par Method of function operation:
 252  * @par Important notes:
 253  * @param[in]           changed_item_s structure
 254  * @param[out]
 255  *
 256  * @return
 257  *
 258  * @par Errors:
 259  *
 260  * @pre None.
 261  * @post
 262  * @see
 263  * @remarks None.
 264  *
 265  * @par Sample Code:
 266  * @code
 267  * @endcode
 268  */
 269 void free_changed_item(changed_item_s * changed_item);
 270
 271 /**
 272  * @par Description: API to set content type in changed_item_s structure
 273  *
 274  *
 275  * @par Purpose:
 276  * @par Typical use case:
 277  * @par Method of function operation:
 278  * @par Important notes:
 279  * @param[in]           changed_item_s structure
 280  * @param[in]           string type, content type
 281  * @param[out]
 282  *
 283  * @return
 284  *
 285  * @par Errors:
 286  *
 287  * @pre None.
 288  * @post
 289  * @see
 290  * @remarks None.
 291  *
 292  * @par Sample Code:
 293  * @code
 294  * @endcode
 295  */
 296 void set_changed_item_content_type(changed_item_s * changed_item, char *content_type);
 297
 298 /**
 299  * @par Description: API to set data in changed_item_s structure
 300  *
 301  *
 302  * @par Purpose:
 303  * @par Typical use case:
 304  * @par Method of function operation:
 305  * @par Important notes:
 306  * @param[in]           changed_item_s structure
 307  * @param[in]           string type, data
 308  * @param[out]
 309  *
 310  * @return
 311  *
 312  * @par Errors:
 313  *
 314  * @pre None.
 315  * @post
 316  * @see
 317  * @remarks None.
 318  *
 319  * @par Sample Code:
 320  * @code
 321  * @endcode
 322  */
 323 void set_changed_item_data(changed_item_s * changed_item, char *data);
 324
 325 /**
 326  * @par Description: API to set in changed_item_s structure
 327  *
 328  *
 329  * @par Purpose:
 330  * @par Typical use case:
 331  * @par Method of function operation:
 332  * @par Important notes:
 333  * @param[in]           changed_item_s structure
 334  * @param[in]           datastore index(0=contacts, 1=calendar, 2= memo)
 335  * @param[out]
 336  *
 337  * @return
 338  *
 339  * @par Errors:
 340  *
 341  * @pre None.
 342  * @post
 343  * @see
 344  * @remarks None.
 345  *
 346  * @par Sample Code:
 347  * @code
 348  * @endcode
 349  */
 350 void set_changed_item_index_of_datastore(changed_item_s * changed_item, unsigned int indexOfDatastore);
 351
 352 /**
 353  * @par Description: API to create changed_datastore_s structure
 354  *
 355  *
 356  * @par Purpose:
 357  * @par Typical use case:
 358  * @par Method of function operation:
 359  * @par Important notes:
 360  * @param[in]           string type, source uri
 361  * @param[in]           string type, target uri
 362  * @param[in]           int type, has numberOfChanges or not
 363  * @param[in]           unsigned int type, if numberOfChanges is true set count else set zero
 364  * @param[out]
 365  *
 366  * @return                              changed_datastore_s on success
 367  *                                                      NULL on error
 368  *
 369  * @par Errors:
 370  *
 371  * @pre None.
 372  * @post
 373  * @see
 374  * @remarks None.
 375  *
 376  * @par Sample Code:
 377  * @code
 378  * @endcode
 379  */
 380 changed_datastore_s *create_changed_datastore(char *source, char *target, int has_number_of_changes, unsigned int number_of_changes);
 381
 382 /**
 383  * @par Description: API to free list of changed_datastore_s
 384  *
 385  *
 386  * @par Purpose:
 387  * @par Typical use case:
 388  * @par Method of function operation:
 389  * @par Important notes:
 390  * @param[in]           list of changed_datastore_s
 391  * @param[out]
 392  *
 393  * @return
 394  *
 395  * @par Errors:
 396  *
 397  * @pre None.
 398  * @post
 399  * @see
 400  * @remarks None.
 401  *
 402  * @par Sample Code:
 403  * @code
 404  * @endcode
 405  */
 406 void free_changed_datastores(GList * changed_datastores);
 407
 408 /**
 409  * @par Description: API to free changed_datastore_s structure
 410  *
 411  *
 412  * @par Purpose:
 413  * @par Typical use case:
 414  * @par Method of function operation:
 415  * @par Important notes:
 416  * @param[in]           changed_datastore_s structure
 417  * @param[out]
 418  *
 419  * @return
 420  *
 421  * @par Errors:
 422  *
 423  * @pre None.
 424  * @post
 425  * @see
 426  * @remarks None.
 427  *
 428  * @par Sample Code:
 429  * @code
 430  * @endcode
 431  */
 432 void free_changed_datastore(changed_datastore_s * changed_datastore);
 433
 434 /**
 435  * @par Description: API to set changed_item in changed_datastore_s structure
 436  *
 437  *
 438  * @par Purpose:
 439  * @par Typical use case:
 440  * @par Method of function operation:
 441  * @par Important notes:
 442  * @param[in]           changed_datastore_s structure
 443  * @param[in]           list of changed_item_s structure
 444  * @param[out]
 445  *
 446  * @return
 447  *
 448  * @par Errors:
 449  *
 450  * @pre None.
 451  * @post
 452  * @see
 453  * @remarks None.
 454  *
 455  * @par Sample Code:
 456  * @code
 457  * @endcode
 458  */
 459 void set_changed_datastore_changed_item(changed_datastore_s * changed_datastore, GList * changed_item);
 460
 461 /**
 462  * @par Description: API to add changed_item in changed_datastore_s structure
 463  *
 464  *
 465  * @par Purpose:
 466  * @par Typical use case:
 467  * @par Method of function operation:
 468  * @par Important notes:
 469  * @param[in]           changed_datastore_s structure
 470  * @param[in]           changed_item_s structure
 471  * @param[out]
 472  *
 473  * @return
 474  *
 475  * @par Errors:
 476  *
 477  * @pre None.
 478  * @post
 479  * @see
 480  * @remarks None.
 481  *
 482  * @par Sample Code:
 483  * @code
 484  * @endcode
 485  */
 486 void add_changed_datastore_changed_item(changed_datastore_s * changed_datastore, changed_item_s * changed_item);
 487
 488 /**
 489  * @par Description: API to create applied_status_s structure
 490  *
 491  *
 492  * @par Purpose:
 493  * @par Typical use case:
 494  * @par Method of function operation:
 495  * @par Important notes:
 496  * @param[in]           string type, luid of item
 497  * @param[in]           enum type, change type( CHANGE_ADD , CHANGE_REPLACE , CHANGE_DELETE)
 498  * @param[in]           int type, status code(200....)
 499  * @param[out]
 500  *
 501  * @return                              applied_status_s on success
 502  *                                                      NULL on error
 503  *
 504  * @par Errors:
 505  *
 506  * @pre None.
 507  * @post
 508  * @see
 509  * @remarks None.
 510  *
 511  * @par Sample Code:
 512  * @code
 513  * @endcode
 514  */
 515 applied_status_s *create_applied_status(char *luid, change_type_e change_type, int status);
 516
 517 /**
 518  * @par Description: API to free list of applied_status_s structure
 519  *
 520  *
 521  * @par Purpose:
 522  * @par Typical use case:
 523  * @par Method of function operation:
 524  * @par Important notes:
 525  * @param[in]           list of applied_status_s structure
 526  * @param[out]
 527  *
 528  * @return
 529  *
 530  * @par Errors:
 531  *
 532  * @pre None.
 533  * @post
 534  * @see
 535  * @remarks None.
 536  *
 537  * @par Sample Code:
 538  * @code
 539  * @endcode
 540  */
 541 void free_applied_statuses(GList * applied_statuses);
 542
 543 /**
 544  * @par Description: API to free applied_status_s structure
 545  *
 546  *
 547  * @par Purpose:
 548  * @par Typical use case:
 549  * @par Method of function operation:
 550  * @par Important notes:
 551  * @param[in]           applied_status_s structure
 552  * @param[out]
 553  *
 554  * @return
 555  *
 556  * @par Errors:
 557  *
 558  * @pre None.
 559  * @post
 560  * @see
 561  * @remarks None.
 562  *
 563  * @par Sample Code:
 564  * @code
 565  * @endcode
 566  */
 567 void free_applied_status(applied_status_s * applied_status);
 568
 569 /**
 570  * @par Description: API to create sending_status_s structure
 571  *
 572  *
 573  * @par Purpose:
 574  * @par Typical use case:
 575  * @par Method of function operation:
 576  * @par Important notes:
 577  * @param[in]           source uri
 578  * @param[in]           target uri
 579  * @param[out]
 580  *
 581  * @return                              sending_status_s on success
 582  *                                                      NULL on error
 583  *
 584  * @par Errors:
 585  *
 586  * @pre None.
 587  * @post
 588  * @see
 589  * @remarks None.
 590  *
 591  * @par Sample Code:
 592  * @code
 593  * @endcode
 594  */
 595 sending_status_s *create_sending_status(char *source, char *target);
 596
 597 /**
 598  * @par Description: API to free list of sending_status_s structure
 599  *
 600  *
 601  * @par Purpose:
 602  * @par Typical use case:
 603  * @par Method of function operation:
 604  * @par Important notes:
 605  * @param[in]           list of sending_status_s structure
 606  * @param[out]
 607  *
 608  * @return
 609  *
 610  * @par Errors:
 611  *
 612  * @pre None.
 613  * @post
 614  * @see
 615  * @remarks None.
 616  *
 617  * @par Sample Code:
 618  * @code
 619  * @endcode
 620  */
 621 void free_sending_statuses(GList * sending_statuses);
 622
 623 /**
 624  * @par Description: API to free sending_status_s structure
 625  *
 626  *
 627  * @par Purpose:
 628  * @par Typical use case:
 629  * @par Method of function operation:
 630  * @par Important notes:
 631  * @param[in]           sending_status_s structure
 632  * @param[out]
 633  *
 634  * @return
 635  *
 636  * @par Errors:
 637  *
 638  * @pre None.
 639  * @post
 640  * @see
 641  * @remarks None.
 642  *
 643  * @par Sample Code:
 644  * @code
 645  * @endcode
 646  */
 647 void free_sending_status(sending_status_s * sending_status);
 648
 649 /**
 650  * @par Description: API to add applied_status_s in sending_status_s structure
 651  *
 652  *
 653  * @par Purpose:
 654  * @par Typical use case:
 655  * @par Method of function operation:
 656  * @par Important notes:
 657  * @param[in]           sending_status_s structure
 658  * @param[in]           applied_status_s structure
 659  * @param[out]
 660  *
 661  * @return
 662  *
 663  * @par Errors:
 664  *
 665  * @pre None.
 666  * @post
 667  * @see
 668  * @remarks None.
 669  *
 670  * @par Sample Code:
 671  * @code
 672  * @endcode
 673  */
 674 void add_sending_status_applied_status(sending_status_s * sending_status, applied_status_s * applied_status);
 675
 676 /**
 677  * @par Description: API to create datastore_s structure
 678  *
 679  *
 680  * @par Purpose:
 681  * @par Typical use case:
 682  * @par Method of function operation:
 683  * @par Important notes:
 684  * @param[in]           string type, target uri
 685  * @param[in]           string type, source uri
 686  * @param[out]
 687  *
 688  * @return                              datastore_s on success
 689  *                                                      NULL on error
 690  *
 691  * @par Errors:
 692  *
 693  * @pre None.
 694  * @post
 695  * @see
 696  * @remarks None.
 697  *
 698  * @par Sample Code:
 699  * @code
 700  * @endcode
 701  */
 702 datastore_s *create_datastore(char *target, char *source);
 703
 704 /**
 705  * @par Description: API to set content type infomation in datastore_s structure
 706  *
 707  *
 708  * @par Purpose:
 709  * @par Typical use case:
 710  * @par Method of function operation:
 711  * @par Important notes:
 712  * @param[in]           datastore_s structure
 713  * @param[in]           int type, datastore_id(TYPE_CONTACT, TYPE_CALENDAR, TYPE_MEMO)
 714  * @param[in]           int type, folder_type_id(9, 8, 10)
 715  * @param[out]
 716  *
 717  * @return
 718  *
 719  * @par Errors:
 720  *
 721  * @pre None.
 722  * @post
 723  * @see
 724  * @remarks None.
 725  *
 726  * @par Sample Code:
 727  * @code
 728  * @endcode
 729  */
 730 void set_datastore_content_type_info(datastore_s * datastore, int datastore_id, int folder_type_id);
 731
 732 /**
 733  * @par Description: API to set account information in datastore_s structure
 734  *
 735  *
 736  * @par Purpose:
 737  * @par Typical use case:
 738  * @par Method of function operation:
 739  * @par Important notes:
 740  * @param[in]           datastore_s structure
 741  * @param[in]           string type, account_id
 742  * @param[in]           string type, account_pw
 743  * @param[out]
 744  *
 745  * @return
 746  *
 747  * @par Errors:
 748  *
 749  * @pre None.
 750  * @post
 751  * @see
 752  * @remarks None.
 753  *
 754  * @par Sample Code:
 755  * @code
 756  * @endcode
 757  */
 758 void set_datastore_account_info(datastore_s * datastore, char *account_id, char *account_pw);
 759
 760 /**
 761  * @par Description: API to set client sync type in datastore_s structure
 762  *
 763  *
 764  * @par Purpose:
 765  * @par Typical use case:
 766  * @par Method of function operation:
 767  * @par Important notes:
 768  * @param[in]           datastore_s structure
 769  * @param[in]           enum type, sync type
 770  * @param[out]
 771  *
 772  * @return
 773  *
 774  * @par Errors:
 775  *
 776  * @pre None.
 777  * @post
 778  * @see
 779  * @remarks None.
 780  *
 781  * @par Sample Code:
 782  * @code
 783  * @endcode
 784  */
 785 void set_datastore_client_sync_type(datastore_s * datastore, alert_type_e sync_type);
 786
 787 /**
 788  * @par Description: API to set server sync type in datastore_s structure
 789  *
 790  *
 791  * @par Purpose:
 792  * @par Typical use case:
 793  * @par Method of function operation:
 794  * @par Important notes:
 795  * @param[in]           datastore_s structure
 796  * @param[in]           enum type, sync type
 797  * @param[out]
 798  *
 799  * @return
 800  *
 801  * @par Errors:
 802  *
 803  * @pre None.
 804  * @post
 805  * @see
 806  * @remarks None.
 807  *
 808  * @par Sample Code:
 809  * @code
 810  * @endcode
 811  */
 812 void set_datastore_server_sync_type(datastore_s * datastore, alert_type_e sync_type);
 813
 814 /**
 815  * @par Description: API to set client anchor in datastore_s structure
 816  *
 817  *
 818  * @par Purpose:
 819  * @par Typical use case:
 820  * @par Method of function operation:
 821  * @par Important notes:
 822  * @param[in]           datastore_s structure
 823  * @param[in]           string type, last anchor
 824  * @param[in]           string type, next anchor
 825  * @param[out]
 826  *
 827  * @return
 828  *
 829  * @par Errors:
 830  *
 831  * @pre None.
 832  * @post
 833  * @see
 834  * @remarks None.
 835  *
 836  * @par Sample Code:
 837  * @code
 838  * @endcode
 839  */
 840 void set_datastore_client_anchor(datastore_s * datastore, char *last_anchor, char *next_anchor);
 841
 842 /**
 843  * @par Description: API to set client anchor in datastore_s structure
 844  *
 845  *
 846  * @par Purpose:
 847  * @par Typical use case:
 848  * @par Method of function operation:
 849  * @par Important notes:
 850  * @param[in]           datastore_s structure
 851  * @param[in]           string type, last anchor
 852  * @param[in]           string type, next anchor
 853  * @param[out]
 854  *
 855  * @return
 856  *
 857  * @par Errors:
 858  *
 859  * @pre None.
 860  * @post
 861  * @see
 862  * @remarks None.
 863  *
 864  * @par Sample Code:
 865  * @code
 866  * @endcode
 867  */
 868 void set_datastore_server_anchor(datastore_s * datastore, char *last_anchor, char *next_anchor);
 869
 870 /**
 871  * @par Description: API to create sync_result_s structure
 872  *
 873  *
 874  * @par Purpose:
 875  * @par Typical use case:
 876  * @par Method of function operation:
 877  * @par Important notes:
 878  * @param[in]           datastore_s structure
 879  * @param[in]           string type, last anchor
 880  * @param[in]           string type, next anchor
 881  * @param[out]
 882  *
 883  * @return                              sync_result_s on success
 884  *                                                      NULL on error
 885  *
 886  * @par Errors:
 887  *
 888  * @pre None.
 889  * @post
 890  * @see
 891  * @remarks None.
 892  *
 893  * @par Sample Code:
 894  * @code
 895  * @endcode
 896  */
 897 sync_result_s *create_sync_result();
 898
 899 /**
 900  * @par Description: API to duplicate sync_result_s structure
 901  *
 902  *
 903  * @par Purpose:
 904  * @par Typical use case:
 905  * @par Method of function operation:
 906  * @par Important notes:
 907  * @param[in]           sync_result_s structure
 908  * @param[out]
 909  *
 910  * @return                              sync_result_s on success
 911  *                                                      NULL on error
 912  *
 913  * @par Errors:
 914  *
 915  * @pre None.
 916  * @post
 917  * @see
 918  * @remarks None.
 919  *
 920  * @par Sample Code:
 921  * @code
 922  * @endcode
 923  */
 924 sync_result_s *dup_sync_result(sync_result_s * org_sync_result);
 925
 926 /**
 927  * @par Description: API to set number of total item in sync_result_s structure
 928  *
 929  *
 930  * @par Purpose:
 931  * @par Typical use case:
 932  * @par Method of function operation:
 933  * @par Important notes:
 934  * @param[in]           sync_result_s structure
 935  * @param[in]           number of total item
 936  * @param[out]
 937  *
 938  * @return
 939  *
 940  * @par Errors:
 941  *
 942  * @pre None.
 943  * @post
 944  * @see
 945  * @remarks None.
 946  *
 947  * @par Sample Code:
 948  * @code
 949  * @endcode
 950  */
 951 void set_number_of_change(sync_result_s * sync_result, unsigned int number_of_change);
 952
 953 /**
 954  * @par Description: API to set number of received item in sync_result_s structure
 955  *
 956  *
 957  * @par Purpose:
 958  * @par Typical use case:
 959  * @par Method of function operation:
 960  * @par Important notes:
 961  * @param[in]           sync_result_s structure
 962  * @param[in]           number of received item
 963  * @param[out]
 964  *
 965  * @return
 966  *
 967  * @par Errors:
 968  *
 969  * @pre None.
 970  * @post
 971  * @see
 972  * @remarks None.
 973  *
 974  * @par Sample Code:
 975  * @code
 976  * @endcode
 977  */
 978 void add_receive_count(sync_result_s * sync_result, unsigned int received_count);
 979
 980 /**
 981  * @par Description: API to set number of add item in sync_result_s structure
 982  *
 983  *
 984  * @par Purpose:
 985  * @par Typical use case:
 986  * @par Method of function operation:
 987  * @par Important notes:
 988  * @param[in]           sync_result_s structure
 989  * @param[in]           number of add item
 990  * @param[out]
 991  *
 992  * @return
 993  *
 994  * @par Errors:
 995  *
 996  * @pre None.
 997  * @post
 998  * @see
 999  * @remarks None.
1000  *
1001  * @par Sample Code:
1002  * @code
1003  * @endcode
1004  */
1005 void add_add_count(sync_result_s * sync_result, unsigned int add_cnt);
1006
1007 /**
1008  * @par Description: API to set number of replace item in sync_result_s structure
1009  *
1010  *
1011  * @par Purpose:
1012  * @par Typical use case:
1013  * @par Method of function operation:
1014  * @par Important notes:
1015  * @param[in]           sync_result_s structure
1016  * @param[in]           number of replace item
1017  * @param[out]
1018  *
1019  * @return
1020  *
1021  * @par Errors:
1022  *
1023  * @pre None.
1024  * @post
1025  * @see
1026  * @remarks None.
1027  *
1028  * @par Sample Code:
1029  * @code
1030  * @endcode
1031  */
1032 void add_replace_count(sync_result_s * sync_result, unsigned int replace_cnt);
1033
1034 /**
1035  * @par Description: API to set number of delete item in sync_result_s structure
1036  *
1037  *
1038  * @par Purpose:
1039  * @par Typical use case:
1040  * @par Method of function operation:
1041  * @par Important notes:
1042  * @param[in]           sync_result_s structure
1043  * @param[in]           number of delete item
1044  * @param[out]
1045  *
1046  * @return
1047  *
1048  * @par Errors:
1049  *
1050  * @pre None.
1051  * @post
1052  * @see
1053  * @remarks None.
1054  *
1055  * @par Sample Code:
1056  * @code
1057  * @endcode
1058  */
1059 void add_delete_count(sync_result_s * sync_result, unsigned int delete_cnt);
1060
1061 /**
1062  * @par Description: API to free PreSyncReturnObj structure
1063  *
1064  *
1065  * @par Purpose:
1066  * @par Typical use case:
1067  * @par Method of function operation:
1068  * @par Important notes:
1069  * @param[in]           pre_sync_return_obj_s structure
1070  * @param[out]
1071  *
1072  * @return
1073  *
1074  * @par Errors:
1075  *
1076  * @pre None.
1077  * @post
1078  * @see
1079  * @remarks None.
1080  *
1081  * @par Sample Code:
1082  * @code
1083  * @endcode
1084  */
1085 void free_pre_sync_return_obj(pre_sync_return_obj_s * pre_sync_return_obj);
1086
1087 /**
1088  * @par Description: API to free sync_obj_s structure
1089  *
1090  *
1091  * @par Purpose:
1092  * @par Typical use case:
1093  * @par Method of function operation:
1094  * @par Important notes:
1095  * @param[in]           sync_obj_s structure
1096  * @param[out]
1097  *
1098  * @return
1099  *
1100  * @par Errors:
1101  *
1102  * @pre None.
1103  * @post
1104  * @see
1105  * @remarks None.
1106  *
1107  * @par Sample Code:
1108  * @code
1109  * @endcode
1110  */
1111 void free_sync_obj(sync_obj_s * sync_obj);
1112
1113 /**
1114  * @par Description: API to free sync_return_obj_s structure
1115  *
1116  *
1117  * @par Purpose:
1118  * @par Typical use case:
1119  * @par Method of function operation:
1120  * @par Important notes:
1121  * @param[in]           sync_return_obj_s structure
1122  * @param[out]
1123  *
1124  * @return
1125  *
1126  * @par Errors:
1127  *
1128  * @pre None.
1129  * @post
1130  * @see
1131  * @remarks None.
1132  *
1133  * @par Sample Code:
1134  * @code
1135  * @endcode
1136  */
1137 void free_sync_return_obj(sync_return_obj_s * sync_return_obj);
1138
1139 /**
1140  * @par Description: API to free datastore_s structure
1141  *
1142  *
1143  * @par Purpose:
1144  * @par Typical use case:
1145  * @par Method of function operation:
1146  * @par Important notes:
1147  * @param[in]           datastore_s structure
1148  * @param[out]
1149  *
1150  * @return
1151  *
1152  * @par Errors:
1153  *
1154  * @pre None.
1155  * @post
1156  * @see
1157  * @remarks None.
1158  *
1159  * @par Sample Code:
1160  * @code
1161  * @endcode
1162  */
1163 void free_datastore(datastore_s * datastore);
1164
1165 /**
1166  * @par Description: API to free sync_category structure
1167  *
1168  *
1169  * @par Purpose:
1170  * @par Typical use case:
1171  * @par Method of function operation:
1172  * @par Important notes:
1173  * @param[in]           sync_service_s structure
1174  * @param[out]
1175  *
1176  * @return
1177  *
1178  * @par Errors:
1179  *
1180  * @pre None.
1181  * @post
1182  * @see
1183  * @remarks None.
1184  *
1185  * @par Sample Code:
1186  * @code
1187  * @endcode
1188  */
1189 void free_sync_service(sync_service_s * category);
1190
1191 #endif                          /* COMMON_DEFINE_H_ */