diff -r 4b1e636e8a71 -r 86af6c333601 example/clientapi/smf/inc/smfplugins/smfmusic/smfmusicsearchplugin.h --- a/example/clientapi/smf/inc/smfplugins/smfmusic/smfmusicsearchplugin.h Thu Mar 25 14:44:08 2010 +0530 +++ b/example/clientapi/smf/inc/smfplugins/smfmusic/smfmusicsearchplugin.h Tue Apr 06 16:35:37 2010 +0530 @@ -8,9 +8,9 @@ * Copyright (c) 2010 Sasken Communication Technologies Ltd. * All rights reserved. * This component and the accompanying materials are made available - * under the terms of the "{License}" + * under the terms of the "Eclipse Public License v1.0" * which accompanies this distribution, and is available - * at the URL "{LicenseUrl}". + * at the URL "http://www.eclipse.org/legal/epl-v10.html" * * @section DESCRIPTION * @@ -20,12 +20,13 @@ #ifndef SMFMUSICSEARCHPLUGIN_H_ #define SMFMUSICSEARCHPLUGIN_H_ -#include +#include #include #include #include /** + * @ingroup smf_plugin_group * Interface specification for music search services. This class * provides basic functionality to allow applications to search for * tracks, get recommented tracks etc @@ -33,7 +34,7 @@ * All of the functionality described here should be implemented by a service * specific plug-in. */ -class SmfMusicSearchPlugin : public QObject +class SmfMusicSearchPlugin : public SmfPluginBase { Q_OBJECT public: @@ -49,96 +50,69 @@ ~SmfMusicSearchPlugin( ); /** - * Method to get the provider information - * @return Instance of SmfProviderBase - */ - virtual SmfProviderBase* getProviderInfo( ) = 0; - - /** * Method to get recommended tracks + * @param aRequest [out] The request data to be sent to network * @param aTrack The track for which similar recommendations * need to be fetched. - * @param aRequest [out] The request data to be sent to network * @param aPageNum The page to be extracted * @param aItemsPerPage Number of items per page * @return SmfPluginError Plugin error if any, else SmfPluginErrNone */ - virtual SmfPluginError recommendations( const SmfTrackInfo aTrack, - SmfPluginRequestData *aRequest, - const int aPageNum = 0, - const int aItemsPerPage = 10 ) = 0; + virtual SmfPluginError recommendations( SmfPluginRequestData *aRequest, + const SmfTrackInfo aTrack, + const int aPageNum = SMF_FIRST_PAGE, + const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; /** * Method to get similar tracks + * @param aRequest [out] The request data to be sent to network * @param aTrack The track for which similar tracks * need to be fetched. - * @param aRequest [out] The request data to be sent to network - * @param aPageNum The page to be extracted - * @param aItemsPerPage Number of items per page - * @return SmfPluginError Plugin error if any, else SmfPluginErrNone - */ - virtual SmfPluginError tracks( const SmfTrackInfo aTrack, - SmfPluginRequestData *aRequest, - const int aPageNum = 0, - const int aItemsPerPage = 10) = 0; - - /** - * Method to get tracks having a similar finger print - * @param aSignature The finger print to be searched for need to be - * fetched. - * @param aRequest [out] The request data to be sent to network * @param aPageNum The page to be extracted * @param aItemsPerPage Number of items per page * @return SmfPluginError Plugin error if any, else SmfPluginErrNone */ - virtual SmfPluginError trackInfo( const SmfMusicFingerPrint aSignature, - SmfPluginRequestData *aRequest, - const int aPageNum = 0, - const int aItemsPerPage = 10 ) = 0; + virtual SmfPluginError tracks( SmfPluginRequestData *aRequest, + const SmfTrackInfo aTrack, + const int aPageNum = SMF_FIRST_PAGE, + const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; /** - * Method to search information about where to buy this song from - * @param aTrack The track for which stores need to be searched + * Method to get tracks having a similar finger print * @param aRequest [out] The request data to be sent to network + * @param aSignature The finger print to be searched for need to be + * fetched. * @param aPageNum The page to be extracted * @param aItemsPerPage Number of items per page * @return SmfPluginError Plugin error if any, else SmfPluginErrNone */ - virtual SmfPluginError stores( const SmfTrackInfo aTrack, - SmfPluginRequestData *aRequest, - const int aPageNum = 0, - const int aItemsPerPage = 10 ) = 0; + virtual SmfPluginError trackInfo( SmfPluginRequestData *aRequest, + const SmfMusicFingerPrint aSignature, + const int aPageNum = SMF_FIRST_PAGE, + const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; + + /** + * Method to search information about where to buy this song from + * @param aRequest [out] The request data to be sent to network + * @param aTrack The track for which stores need to be searched + * @param aPageNum The page to be extracted + * @param aItemsPerPage Number of items per page + * @return SmfPluginError Plugin error if any, else SmfPluginErrNone + */ + virtual SmfPluginError stores( SmfPluginRequestData *aRequest, + const SmfTrackInfo aTrack, + const int aPageNum = SMF_FIRST_PAGE, + const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; /** * Method to post the currently playing track + * @param aRequest [out] The request data to be sent to network * @param aTrack The current playing track, that should be posted - * @param aRequest [out] The request data to be sent to network * @return SmfPluginError Plugin error if any, else SmfPluginErrNone */ - virtual SmfPluginError postCurrentPlaying( const SmfTrackInfo aTrack, - SmfPluginRequestData *aRequest ) = 0; - - - /** - * Method to get the result for a network request. - * @param aTransportResult The result of transport operation - * @param aReply The QNetworkReply instance for the request - * @param aResult [out] An output parameter to the plugin manager.If the - * return value is SmfSendRequestAgain, QVariant will be of type - * SmfPluginRequestData. - * If last operation was recommendations()or tracks() or trackInfo(), - * aResult will be of type QList - * If last operation was postCurrentPlaying(), aResult will be of type bool - * @param aRetType [out] SmfPluginRetType - * @param aIsLastPage [out] true if this the last page, else false - * @return SmfPluginError - */ - virtual SmfPluginError responseAvailable( - const SmfTransportResult aTransportResult, - QNetworkReply *aReply, - QVariant* aResult, - SmfPluginRetType aRetType, - bool aIsLastPage) = 0; + virtual SmfPluginError postCurrentPlaying( + SmfPluginRequestData *aRequest, + const SmfTrackInfo aTrack ) = 0; };