1 /**

     2  * @file	smfmusicserviceplugin.h

     3  * @author  Nalina Hariharan, Sasken Communication Technologies Ltd - Initial contribution

     4  * @version 1.0

     5  *

     6  * @section LICENSE

     7  *

     8  * Copyright (c) 2010 Sasken Communication Technologies Ltd. 

     9  * All rights reserved.

    10  * This component and the accompanying materials are made available 

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

    12  * which accompanies  this distribution, and is available 

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

    14  * 

    15  * @section DESCRIPTION

    16  *

    17  * Interface specification for music services

    18  */

    19 

    20 #ifndef SMFMUSICSERVICEPLUGIN_H_

    21 #define SMFMUSICSERVICEPLUGIN_H_

    22 

    23 #include <smfpluginbase.h>

    24 #include <smfmusicprofile.h>

    25 #include <smfplace.h>

    26 

    27 /**

    28  * @ingroup smf_plugin_group

    29  * Interface specification for music services. This class provides basic 

    30  * functionality to allow application to search for a user or check for

    31  * user information etc.

    32  *

    33  * All of the functionality described here should be implemented by a service

    34  * specific plug-in.

    35  */

    36 class SmfMusicServicePlugin : public SmfPluginBase

    37 	{

    38 	Q_OBJECT

    39 public:

    40 	/**

    41 	 * Constructor with default argument

    42 	 * @param aParent The parent object

    43 	 */

    44 	SmfMusicServicePlugin( QObject *aParent = 0 );

    45 	

    46 	/**

    47 	 * Destructor

    48 	 */

    49 	~SmfMusicServicePlugin( );

    50 	

    51 	/**

    52 	 * Method to get self profile information

    53 	 * @param aRequest [out] The request data to be sent to network

    54 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone

    55 	 */

    56 	virtual SmfPluginError userInfo( SmfPluginRequestData *aRequest ) = 0;

    57 	

    58 	/**

    59 	 * Method to search information about other service users for a 

    60 	 * particular place

    61 	 * @param aRequest [out] The request data to be sent to network

    62 	 * @param aPlace The place which is the search criteria

    63 	 * @param aPageNum The page to be extracted

    64 	 * @param aItemsPerPage Number of items per page

    65 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone

    66 	 */

    67 	virtual SmfPluginError searchUser( SmfPluginRequestData *aRequest,

    68 			const SmfPlace aPlace,

    69 			const int aPageNum = SMF_FIRST_PAGE, 

    70 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;

    71 	

    72 	};

    73 

    74 Q_DECLARE_INTERFACE( SmfMusicServicePlugin, "org.symbian.smf.plugin.music.service/v1.0" );

    75 

    76 #endif /* SMFMUSICSERVICEPLUGIN_H_ */