diff -r c39a6cfd1fb9 -r be09cf1f39dd smf/smfservermodule/smfclient/common/smfmusicprofile.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/smf/smfservermodule/smfclient/common/smfmusicprofile.h Tue May 18 17:37:12 2010 +0530 @@ -0,0 +1,147 @@ +/** + * Copyright (c) 2010 Sasken Communication Technologies Ltd. + * All rights reserved. + * This component and the accompanying materials are made available + * under the terms of the "Eclipse Public License v1.0" + * which accompanies this distribution, and is available + * at the URL "http://www.eclipse.org/legal/epl-v10.html" + * + * Initial Contributors: + * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution + * + * Contributors: + * Manasij Roy, Nalina Hariharan + * + * Description: + * The music profile class represents a user's profile in music site + * + */ + +#ifndef SMFMUSICPROFILE_H_ +#define SMFMUSICPROFILE_H_ + +#include +#include +#include +#include +#include +#include + +class SmfMusicProfilePrivate; + +/** + * @ingroup smf_common_group + * The music profile class represents a user's profile in music site + */ +class SMFCLIENT_EXPORT SmfMusicProfile + { +public: + /** + * Constructor with default argument + */ + SmfMusicProfile( ); + + /** + * Copy Constructor + * @param aOther The reference object + */ + SmfMusicProfile( const SmfMusicProfile &aOther ); + + /** + * Overloaded = operator + * @param aOther The reference object + */ + SmfMusicProfile& operator=( const SmfMusicProfile &aOther ); + + /** + * Destructor + */ + ~SmfMusicProfile( ); + + /** + * Method to get the user's used tracks + * @return The users track list + */ + QList musicUsageInfo( ) const; + + /** + * Method to get the user's interested tracks + * @return The users interested track list + */ + QList interestInfo( ) const; + + /** + * Method to get the user events as list of SmfEvents + * @return The list of events + */ + QList userEvents( ) const; + + /** + * Method to get the id of the music profile + * @return The ID value + */ + QString id( ) const; + + /** + * Method to set the user's used tracks + * @param aUsage The users new track list + */ + void setMusicUsageInfo( const QList& aUsage ); + + /** + * Method to set the user's interested tracks + * @param aInterest The users new interested track list + */ + void setInterestInfo( const QList& aInterest ); + + /** + * Method to set the user events as list of SmfEvents + * @param aList The list of events + */ + void setUserEvents( const QList &aList ); + + /** + * Method to set the id of the music profile + * @param aId The ID value + */ + void setId( const QString &aId ); + +private: + QSharedDataPointer d; + + friend QDataStream &operator<<( QDataStream &aDataStream, + const SmfMusicProfile &aProfile ); + + friend QDataStream &operator>>( QDataStream &aDataStream, + SmfMusicProfile &aProfile ); + + }; + + +/** + * Method for Externalization. Writes the SmfMusicProfile object to + * the stream and returns a reference to the stream. + * @param aDataStream Stream to be written + * @param aProfile The SmfMusicProfile object to be externalized + * @return reference to the written stream + */ +SMFCLIENT_EXPORT QDataStream &operator<<( QDataStream &aDataStream, + const SmfMusicProfile &aProfile ); + +/** + * Method for Internalization. Reads a SmfMusicProfile object from + * the stream and returns a reference to the stream. + * @param aDataStream Stream to be read + * @param aProfile The SmfMusicProfile object to be internalized + * @return reference to the stream + */ +SMFCLIENT_EXPORT QDataStream &operator>>( QDataStream &aDataStream, + SmfMusicProfile &aProfile); + +typedef QList SmfMusicProfileList; + +// Make the class SmfMusicProfile known to QMetaType, so that as to register it. +Q_DECLARE_METATYPE(SmfMusicProfile) +Q_DECLARE_METATYPE(QList) + +#endif /* SMFMUSICPROFILE_H_ */