williamr@2: /*
williamr@2: * Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description: 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef MCLFITEM_H
williamr@2: #define MCLFITEM_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <CLFContentListing.hrh>
williamr@2: #include <CLFContentListing.h>
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class MCLFItemExt;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: *  Content Listing Framework item.
williamr@2: *  All items that are fetched from server have got an Item ID number.
williamr@2: *  Item ID is defined in runtime so do not store Item IDs permanently.
williamr@2: *  One item can contain multiple fields. The field consists of a Field ID and
williamr@2: *  field data. Type of the field is defined with Field ID: see
williamr@2: *  TCLFDefaultFieldId in CLFContentListing.hrh.
williamr@2: *  For example, a music file could contain these two fields:
williamr@2: *  ECLFFieldIdSongName (data: title of the song) and ECLFFieldIdArtist
williamr@2: *  (data: name of the artist).<br><br>
williamr@2: *  Usage:
williamr@2: *  @code
williamr@2: *  // Get file names and sizes of all items
williamr@2: *  TInt count( listModel->ItemCount() );
williamr@2: *  for( TInt i = 0 ; i < count ; ++i )
williamr@2: *      {
williamr@2: *      const MCLFItem& myItem = listModel->Item( i );
williamr@2: *
williamr@2: *      // Get file name of an item (string data)
williamr@2: *      TPtrC fileName;
williamr@2: *      TInt error( myItem.GetField( ECLFFieldIdFileName, fileName ) );
williamr@2: *
williamr@2: *      ...
williamr@2: *
williamr@2: *      // Get file size of an item (integer data)
williamr@2: *      TInt32 size( 0 );
williamr@2: *      error = myItem.GetField( ECLFFieldIdFileSize, size );
williamr@2: *
williamr@2: *      ...
williamr@2: *
williamr@2: *      }
williamr@2: *  @endcode
williamr@2: *
williamr@2: *  @lib ContentListingFramwork.lib
williamr@2: *  @since S60 3.1
williamr@2: */
williamr@2: class MCLFItem
williamr@2:     {
williamr@2:     public:  // Destructor
williamr@2: 
williamr@2:         /**
williamr@2:         * Destructor.
williamr@2:         */
williamr@2:         virtual ~MCLFItem() {}
williamr@2: 
williamr@2:     public: // New functions
williamr@2: 
williamr@2:         /**
williamr@2:         * Get Item ID of the item.
williamr@2:         * @since S60 3.1
williamr@2:         * @return Item ID of the item
williamr@2:         */
williamr@2:         virtual TCLFItemId ItemId() const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Get data type of the field. Data type can be text, time or integer.
williamr@2:         * @since S60 3.1
williamr@2:         * @param aFieldId ID of the field (TCLFDefaultFieldId)
williamr@2:         * @return Data type of the field.
williamr@2:         *         ECLFItemDataTypeNull, if the field does not exist in the item.
williamr@2:         */
williamr@2:         virtual TCLFItemDataType DataType( TCLFFieldId aFieldId ) const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Get field data that is a string.
williamr@2:         * @since S60 3.1
williamr@2:         * @param aFieldId ID of the field (TCLFDefaultFieldId)
williamr@2:         * @param aData Data of the field
williamr@2:         * @return System wide error code.
williamr@2:         *         KErrNone if field exist,
williamr@2:         *         KErrNotFound if field doesn't exist,
williamr@2:         *         KErrNotSupported if field type doesn't match
williamr@2:         */
williamr@2:         virtual TInt GetField( TCLFFieldId aFieldId, TPtrC& aData ) const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Get field data that is an integer.
williamr@2:         * @since S60 3.1
williamr@2:         * @param aFieldId ID of the field (TCLFDefaultFieldId)
williamr@2:         * @param aData Data of the field
williamr@2:         * @return System wide error code.
williamr@2:         *         KErrNone if field exist,
williamr@2:         *         KErrNotFound if field doesn't exist,
williamr@2:         *         KErrNotSupported if field type doesn't match
williamr@2:         */
williamr@2:         virtual TInt GetField( TCLFFieldId aFieldId, TInt32& aData ) const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Get field data that is a time data.
williamr@2:         * @since S60 3.1
williamr@2:         * @param aFieldId ID of the field (TCLFDefaultFieldId)
williamr@2:         * @param aData Data of the field
williamr@2:         * @return System wide error code.
williamr@2:         *         KErrNone if field exist,
williamr@2:         *         KErrNotFound if field doesn't exist,
williamr@2:         *         KErrNotSupported if field type doesn't match
williamr@2:         */
williamr@2:         virtual TInt GetField( TCLFFieldId aFieldId, TTime& aData ) const = 0;
williamr@2: 
williamr@2:     private: // Extension interface
williamr@2: 
williamr@2:         /**
williamr@2:         * This member is internal and not intended for use.
williamr@2:         */
williamr@2:         virtual MCLFItemExt* Extension() { return NULL; }
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: #endif      // MCLFITEM_H
williamr@2: 
williamr@2: // End of File