/**

 * Copyright (c) 2010 Sasken Communication Technologies Ltd.

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of the "Eclipse Public License v1.0" 

 * which accompanies  this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html"

 *

 * Initial Contributors:

 * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution

 *

 * Contributors:

 * Manasij Roy, Nalina Hariharan

 * 

 * Description:

 * The SmfEvent class represents an event

 *

 */

#include "smfglobal.h"

#include "smfplace.h"

typedef QList<SmfContact>  SmfContactList;

 * @ingroup smf_client_group 

   * be generated by SMF factory of some kind

  SmfContactFetcher(SmfProvider* baseProvider);

  SmfContactFetcher(SmfProvider* baseProvider, SmfContact* contact);

   * is emitted with SmfContactList once data is arrived.

   * When the list is big user can specify the page number and per page item data.

   * If not supplied by the user default values are used.

   * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.

   * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE

  bool friends(int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE);

   * is emitted with SmfContactList once data is arrived. Please note that some

   * service may not support followers/fans - FALSE is returned if not supported.

   * When the list is big user can specify the page number and per page item data.

   * If not supplied by the user default values are used.

   * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.

   * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE

  bool followers(int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE); // list of contact objects

   * is emitted with SmfContactList once data is arrived.

   * When the list is big user can specify the page number and per page item data.

   * If not supplied by the user default values are used.

   * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.

   * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE

  void search(SmfContact* contact,int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE) ; // list of contact objects

  /**

   * Searches for a contacts (friends) who are near the user.

   * Signal searchNearFinished() is emitted with SmfContactList once data is arrived.

   * Proximity defines accuracy level

   * When the list is big user can specify the page number and per page item data.

   * If not supplied by the user default values are used.

   * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.

   * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE

   */

   bool searchNear(SmfPlace* location,SmfLocationSearchBoundary proximity,int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE) ;

   * is emitted with SmfGroupList once data is arrived. False might be returned

   * if this service doesn't support any mode of grouping (very rare).

   * When the list is big user can specify the page number and per page item data.

   * If not supplied by the user default values are used.

   * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.

   * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE

   bool groups(int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE) ; // list of group objects

   * Searches for Smf Contacts in an Smf group.

   * When the list is big user can specify the page number and per page item data.

   * If not supplied by the user default values are used.

   * @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.

   * @param perPage Item per page, default is SMF_ITEMS_PER_PAGE

   bool searchInGroup(SmfGroup group,int pageNum=SMF_FIRST_PAGE,int perPage=SMF_ITEMS_PER_PAGE) ; // list of contact objects

   SmfProvider* getProvider() ;

signals:

	 *  @param resultPage Page number info

	void friendsListAvailable(SmfContactList* list, QString error, SmfResultPage resultPage);

	 *  @param resultPage Page number info

	void followersListAvailable(SmfContactList* list, QString error, SmfResultPage resultPage);

	 *  @param resultPage Page number info

	void groupListAvailable(SmfGroupList* list, QString error, SmfResultPage resultPage);

	 * @param resultPage Page number info

	void searchContactFinished(SmfContactList* list,QString error, SmfResultPage resultPage);

	/**

	 * Emitted when search for contacts who are near a geographic location, is finished.

	 * Note if number of contacts in the search is large, then it can download the list page by page

	 * In that case this signal is emitted multiple times.

	 * @param list List of filtered contacts

	 * @param resultPage Page number info

	 * @see search()

	 */

	void searchNearFinished(SmfContactList* list,QString error, SmfResultPage resultPage);

	 * @param resultPage Page number info

	void searchInGroupFinished(SmfContactList* list,QString error, SmfResultPage resultPage);

SMF_SERVICE_NAME(SmfContactFetcher, "org.symbian.smf.client.contact.fetcher\0.2")