smf/smfservermodule/smfserver/smfplugins/smfmusicserviceplugin.h
changeset 25 a180113055cb
parent 18 013a02bf2bb0
equal deleted inserted replaced
24:1cee9f1b95e0 25:a180113055cb
    47 	virtual ~SmfMusicServicePlugin( ) {}
    47 	virtual ~SmfMusicServicePlugin( ) {}
    48 	
    48 	
    49 	/**
    49 	/**
    50 	 * Method to get self profile information
    50 	 * Method to get self profile information
    51 	 * @param aRequest [out] The request data to be sent to network
    51 	 * @param aRequest [out] The request data to be sent to network
    52 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    52 	 * @return Appropriate value of the enum SmfPluginError.
       
    53 	 * Plugin error if any, else SmfPluginErrNone for success
    53 	 */
    54 	 */
    54 	virtual SmfPluginError userInfo( SmfPluginRequestData &aRequest ) = 0;
    55 	virtual SmfPluginError userMusicInfo( SmfPluginRequestData &aRequest ) = 0;
       
    56 	
       
    57 	/**
       
    58 	 * Method to search information about artists. All information 
       
    59 	 * in SmfArtists is not required, however more available the better
       
    60 	 * @param aRequest [out] The request data to be sent to network
       
    61 	 * @param aArtist The artist which is the search criteria
       
    62 	 * @param aPageNum The page to be extracted
       
    63 	 * @param aItemsPerPage Number of items per page
       
    64 	 * @return Appropriate value of the enum SmfPluginError.
       
    65 	 * Plugin error if any, else SmfPluginErrNone for success
       
    66 	 */
       
    67 	virtual SmfPluginError searchArtist( SmfPluginRequestData &aRequest,
       
    68 			const SmfArtists &aArtist,
       
    69 			const int aPageNum = SMF_FIRST_PAGE, 
       
    70 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
       
    71 	
       
    72 	/**
       
    73 	 * Method to search information about album. All information 
       
    74 	 * in SmfAlbum is not required, however more available the better
       
    75 	 * @param aRequest [out] The request data to be sent to network
       
    76 	 * @param aAlbum [in] The album which is the search criteria
       
    77 	 * @param aPageNum [in] The page to be extracted
       
    78 	 * @param aItemsPerPage [in] Number of items per page
       
    79 	 * @return Appropriate value of the enum SmfPluginError.
       
    80 	 * Plugin error if any, else SmfPluginErrNone for success
       
    81 	 */
       
    82 	virtual SmfPluginError searchAlbum( SmfPluginRequestData &aRequest,
       
    83 			const SmfAlbum &aAlbum,
       
    84 			const int aPageNum = SMF_FIRST_PAGE, 
       
    85 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
       
    86 	
       
    87 	/**
       
    88 	 * Method to search information about events. All information 
       
    89 	 * in SmfEvent is not required, however more available the better
       
    90 	 * @param aRequest [out] The request data to be sent to network
       
    91 	 * @param aEvent [in] The event which is the search criteria
       
    92 	 * @param aPageNum [in] The page to be extracted
       
    93 	 * @param aItemsPerPage [in] Number of items per page
       
    94 	 * @return Appropriate value of the enum SmfPluginError.
       
    95 	 * Plugin error if any, else SmfPluginErrNone for success
       
    96 	 */
       
    97 	virtual SmfPluginError searchEvents( SmfPluginRequestData &aRequest,
       
    98 			const SmfEvent &aEvent,
       
    99 			const int aPageNum = SMF_FIRST_PAGE, 
       
   100 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
       
   101 	
       
   102 	/**
       
   103 	 * Method to search information about venue. All information 
       
   104 	 * in SmfLocation is not required, however more available the better
       
   105 	 * @param aRequest [out] The request data to be sent to network
       
   106 	 * @param aVenue [in] The venue which is the search criteria
       
   107 	 * @param aPageNum [in] The page to be extracted
       
   108 	 * @param aItemsPerPage [in] Number of items per page
       
   109 	 * @return Appropriate value of the enum SmfPluginError.
       
   110 	 * Plugin error if any, else SmfPluginErrNone for success
       
   111 	 */
       
   112 	virtual SmfPluginError searchVenue( SmfPluginRequestData &aRequest,
       
   113 			const SmfLocation &aVenue,
       
   114 			const int aPageNum = SMF_FIRST_PAGE, 
       
   115 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    55 	
   116 	
    56 	/**
   117 	/**
    57 	 * Method to search information about other service users for a 
   118 	 * Method to search information about other service users for a 
    58 	 * particular place
   119 	 * particular place
    59 	 * @param aRequest [out] The request data to be sent to network
   120 	 * @param aRequest [out] The request data to be sent to network
    60 	 * @param aPlace The place which is the search criteria
   121 	 * @param aPlace [in] The place which is the search criteria
    61 	 * @param aPageNum The page to be extracted
   122 	 * @param aPageNum [in] The page to be extracted
    62 	 * @param aItemsPerPage Number of items per page
   123 	 * @param aItemsPerPage [in] Number of items per page
    63 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   124 	 * @return Appropriate value of the enum SmfPluginError.
       
   125 	 * Plugin error if any, else SmfPluginErrNone for success
    64 	 */
   126 	 */
    65 	virtual SmfPluginError searchUser( SmfPluginRequestData &aRequest,
   127 	virtual SmfPluginError searchUser( SmfPluginRequestData &aRequest,
    66 			const SmfLocation &aPlace,
   128 			const SmfLocation &aPlace,
    67 			const int aPageNum = SMF_FIRST_PAGE, 
   129 			const int aPageNum = SMF_FIRST_PAGE, 
    68 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
   130 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    69 	
   131 	
    70 	/**
   132 	/**
    71 	 * Method to post the currently playing track
   133 	 * Method to post the currently playing track
    72 	 * @param aRequest [out] The request data to be sent to network
   134 	 * @param aRequest [out] The request data to be sent to network
    73 	 * @param aTrack The current playing track, that should be posted
   135 	 * @param aTrack [in] The current playing track, that should be posted
    74 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   136 	 * @return Appropriate value of the enum SmfPluginError.
       
   137 	 * Plugin error if any, else SmfPluginErrNone for success
    75 	 */
   138 	 */
    76 	virtual SmfPluginError postCurrentPlaying( 
   139 	virtual SmfPluginError postCurrentPlaying( 
    77 			SmfPluginRequestData &aRequest,
   140 			SmfPluginRequestData &aRequest,
    78 			const SmfTrackInfo &aTrack ) = 0;
   141 			const SmfTrackInfo &aTrack ) = 0;
    79 	
   142 	
    80 	/**
   143 	/**
    81 	 * Method to post the rating on a track
   144 	 * Method to post the rating on a track
    82 	 * @param aRequest [out] The request data to be sent to network
   145 	 * @param aRequest [out] The request data to be sent to network
    83 	 * @param aTrack The track on which rating should be posted
   146 	 * @param aTrack [in] The track on which rating should be posted
    84 	 * @param aRating The rating values
   147 	 * @param aRating [in] The rating values
    85 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   148 	 * @return Appropriate value of the enum SmfPluginError.
       
   149 	 * Plugin error if any, else SmfPluginErrNone for success
    86 	 */
   150 	 */
    87 	virtual SmfPluginError postRating( 
   151 	virtual SmfPluginError postRating( 
    88 			SmfPluginRequestData &aRequest, 
   152 			SmfPluginRequestData &aRequest, 
    89 			const SmfTrackInfo &aTrack, 
   153 			const SmfTrackInfo &aTrack, 
    90 			const SmfMusicRating &aRating ) = 0;
   154 			const SmfMusicRating &aRating ) = 0;
    91 	
   155 	
    92 	/**
   156 	/**
    93 	 * Method to post comment on a track
   157 	 * Method to post comment on a track
    94 	 * @param aRequest [out] The request data to be sent to network
   158 	 * @param aRequest [out] The request data to be sent to network
    95 	 * @param aTrack The track on which comment should be posted
   159 	 * @param aTrack [in] The track on which comment should be posted
    96 	 * @param aComment The comment content
   160 	 * @param aComment [in] The comment content
    97 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   161 	 * @return Appropriate value of the enum SmfPluginError.
       
   162 	 * Plugin error if any, else SmfPluginErrNone for success
    98 	 */
   163 	 */
    99 	virtual SmfPluginError postComments( 
   164 	virtual SmfPluginError postComments( 
   100 			SmfPluginRequestData &aRequest, 
   165 			SmfPluginRequestData &aRequest, 
   101 			const SmfTrackInfo &aTrack, 
   166 			const SmfTrackInfo &aTrack, 
   102 			const SmfComment &aComment ) = 0;
   167 			const SmfComment &aComment ) = 0;
   103 	
   168 	
   104 	/**
   169 	/**
   105 	 * Customised method for SmfMusicServicePlugin interface
   170 	 * Customised method for SmfMusicServicePlugin interface
   106 	 * @param aRequest [out] The request data to be sent to network
   171 	 * @param aRequest [out] The request data to be sent to network
   107 	 * @param aOperation The operation type (should be known between 
   172 	 * @param aOperation [in] The operation type (should be known between 
   108 	 * the client interface and the plugin)
   173 	 * the client interface and the plugin)
   109 	 * @param aData The data required to form the request (The type 
   174 	 * @param aData [in] The data required to form the request (The type 
   110 	 * of data should be known between client and the plugin)
   175 	 * of data should be known between client and the plugin)
   111 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   176 	 * @return Appropriate value of the enum SmfPluginError.
       
   177 	 * Plugin error if any, else SmfPluginErrNone for success
   112 	 */
   178 	 */
   113 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
   179 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
   114 			const int &aOperation, QByteArray *aData ) = 0;
   180 			const int &aOperation, QByteArray *aData ) = 0;
   115 	
   181 	
   116 	};
   182 	};