example/clientapi/smf/inc/smfplugins/smfmusic/smflyricsserviceplugin.h
changeset 2 86af6c333601
parent 1 4b1e636e8a71
--- a/example/clientapi/smf/inc/smfplugins/smfmusic/smflyricsserviceplugin.h	Thu Mar 25 14:44:08 2010 +0530
+++ b/example/clientapi/smf/inc/smfplugins/smfmusic/smflyricsserviceplugin.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,20 +20,20 @@
 #ifndef SMFLYRICSSERVICEPLUGIN_H_
 #define SMFLYRICSSERVICEPLUGIN_H_
 
-#include <smfproviderbase.h>
+#include <smfpluginbase.h>
 #include <smftrackinfo.h>
 #include <QString>
 #include <smfsubtitle.h>
 #include <smflyrics.h>
-#include <smfsubtitlesearchfilter.h>
 
 /**
+ * @ingroup smf_plugin_group
  * Interface specification for music track lyrics
  *
  * All of the functionality described here should be implemented by a service
  * specific plug-in.
  */
-class SmfLyricsServicePlugin : public QObject
+class SmfLyricsServicePlugin : public SmfPluginBase
 	{
 	Q_OBJECT
 public:
@@ -49,50 +49,24 @@
 	~SmfLyricsServicePlugin( );
 	
 	/**
-	 * Method to get the provider information
-	 * @return Instance of SmfProviderBase
-	 */
-	virtual SmfProviderBase* getProviderInfo( ) = 0;
-	
-	/**
 	 * Method to get the lyrics
+	 * @param aRequest [out] The request data to be sent to network
 	 * @param aTrack The track whose lyrics need to be fetched
-	 * @param aRequest [out] The request data to be sent to network
 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
 	 */
-	virtual SmfPluginError lyrics( const SmfTrackInfo aTrack,
-			SmfPluginRequestData *aRequest ) = 0;
+	virtual SmfPluginError lyrics( SmfPluginRequestData *aRequest, 
+			const SmfTrackInfo aTrack ) = 0;
 	
 	/**
 	 * Method to get the subtitle
+	 * @param aRequest [out] The request data to be sent to network
 	 * @param aTrack The track whose subtitle need to be fetched
-	 * @param aRequest [out] The request data to be sent to network
 	 * @param aFilter The subtitle search filter if any
 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
 	 */
-	virtual SmfPluginError subtitles( const SmfTrackInfo aTrack,
-			SmfPluginRequestData *aRequest,
-			const SmfSubtitleSearchFilter aFilter = 0 ) = 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 lyrics(), aResult will be of type SmfLyrics
-	 * If last operation was subtitles(), aResult will be of type SmfSubtitle
-	 * @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 subtitles( SmfPluginRequestData *aRequest, 
+			const SmfTrackInfo aTrack,
+			const SmfSubtitleSearchFilter aFilter = SubtitleAll ) = 0;
 	
 	};