/**
* @file smfmusicserviceplugin.h
* @author Nalina Hariharan, Sasken Communication Technologies Ltd - Initial contribution
* @version 1.0
*
* @section LICENSE
*
* 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}"
* which accompanies this distribution, and is available
* at the URL "{LicenseUrl}".
*
* @section DESCRIPTION
*
* Interface specification for music services
*/
#ifndef SMFMUSICSERVICEPLUGIN_H_
#define SMFMUSICSERVICEPLUGIN_H_
#include <smfproviderbase.h>
#include <smfmusicprofile.h>
#include <smfvenue.h>
/**
* Interface specification for music services. This class provides basic
* functionality to allow application to search for a user or check for
* user information etc.
*
* All of the functionality described here should be implemented by a service
* specific plug-in.
*/
class SmfMusicServicePlugin : public QObject
{
Q_OBJECT
public:
/**
* Constructor with default argument
* @param aParent The parent object
*/
SmfMusicServicePlugin( QObject *aParent = 0 );
/**
* Destructor
*/
~SmfMusicServicePlugin( );
/**
* Method to get the provider information
* @return Instance of SmfProviderBase
*/
virtual SmfProviderBase* getProviderInfo( ) = 0;
/**
* Method to get self profile information
* @param aRequest [out] The request data to be sent to network
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
virtual SmfPluginError userInfo( SmfPluginRequestData *aRequest ) = 0;
/**
* Method to search information about other service users for a
* particular venue
* @param aVenue The venue which is the search criteria
* @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 searchUser( const SmfVenue aVenue,
SmfPluginRequestData *aRequest,
const int aPageNum = 0,
const int aItemsPerPage = 10) = 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 userInfo(), aResult will be of type SmfMusicProfile
* If last operation was searchUser(), aResult will be of type
* QList<SmfMusicProfile>
* @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;
};
Q_DECLARE_INTERFACE( SmfMusicServicePlugin, "org.symbian.smf.plugin.music.service/v1.0" );
#endif /* SMFMUSICSERVICEPLUGIN_H_ */