/*

* Copyright (c) 2006-2008 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "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:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:   Public utility classes for NCD provider usage.

*

*/

#ifndef M_NCD_UTILS_H

#define M_NCD_UTILS_H

#include <e32cmn.h>

#include <s32strm.h>

#include <badesca.h>

#include "ncdkeyvaluepair.h"

#include "ncdpurchasedownloadinfo.h"

#include "ncdpurchaseinstallinfo.h"

#include "ncdpurchasehistoryfilter.h"

#include "ncdpurchasedetails.h"

#include "ncdsearchfilter.h"

class MNcdClientLocalizer;

class CNcdString;

class CNcdAttributes;

/**

 *  A default implementation for the MNcdKeyValuePair interface,

 *  providing storage for the key and value in simple heap allocated

 *  buffers.

 *

 *  @lib ncdutils_20019119.dll

 *  

 *  @see MNcdKeyValuePair

 */

class CNcdKeyValuePair : public CBase, public MNcdKeyValuePair

    {

public: // Construction & destruction

    /**

     * Constructor.

     *

     * @param aKey Key. Can not be empty

     * @param aValue Value. Can be an empty descriptor

     * 

     * @return Pointer to the created object.

     * @exception System wide error code.

     * @throw KErrArgument if aKey is empty

     */

    IMPORT_C static CNcdKeyValuePair* NewL( 

        const TDesC& aKey, const TDesC& aValue );

    /**

     * Constructor, leaves pointer on clean-up stack.

     *

     * @param aKey Key. Can not be empty

     * @param aValue Value. Can be an empty descriptor

     * 

     * @return Pointer to the created object.

     * @exception System wide error code.

     * @throw KErrArgument if aKey is empty

     */

    IMPORT_C static CNcdKeyValuePair* NewLC(

        const TDesC& aKey, const TDesC& aValue );

    /**

    * Creates a copy of an key-value -pair.

    * 

    * @param aOther Pair to copy

    * @return A copy of the given pair

    */

    IMPORT_C static CNcdKeyValuePair* NewL( const MNcdKeyValuePair& aOther );

   /**

    * Creates a copy of the key-value -pair, leaves pointer on clean-up stack

    * 

    * @param aOther Pair to copy

    * @return A copy of the given pair

    */

    IMPORT_C static CNcdKeyValuePair* NewLC( const MNcdKeyValuePair& aOther );

    /** 

     * Internalizes the key-value pair from a stream

     *

     * @param aStream

     * @return A new key-value pair

     */     

    IMPORT_C static CNcdKeyValuePair* NewL( RReadStream& aStream );

    /** 

     * Internalizes the key-value pair from a stream

     *

     * @param aStream

     * @return A new key-value pair

     */     

    IMPORT_C static CNcdKeyValuePair* NewLC( RReadStream& aStream );

    /**

     * Destructor.

     *

     * 

     */

    virtual ~CNcdKeyValuePair();

public: // from MNcdKeyValuePair

    /**

     * Returns the key set for the pair.

     * 

     * 

     * @return Key of the pair.

     */

    const TDesC& Key() const;

    /**

     * Returns the value set for the pair.

     * 

     * 

     * @return Value of the pair.

     */

    const TDesC& Value() const;

public: // new functions

    /**

     * Set the key for the pair.

     * 

     * 

     * @param aKey Key for the pair.     

     * @throw KErrArgument if the key is empty

     */

    IMPORT_C void SetKeyL( const TDesC& aKey );

    /**

     * Set the value for the pair.

     * 

     * 

     * @param aValue value for the pair.

     */

    IMPORT_C void SetValueL( const TDesC& aValue );

    /** 

     * Comparison method. Compares the keys of two pairs to 

     * determine equivalence.

     *

     * @return  Boolean, ETrue if pairs match.

     */

    IMPORT_C static TBool MatchByKey( 

        const CNcdKeyValuePair& aFirst, 

        const CNcdKeyValuePair& aSecond );

    /**

     * Externalizes the pair to a stream

     *

     * @param aStream Target stream

     */

    IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;

    /**

     * Externalizes the pair to a descriptor

     *

     * @return Descriptor containing the pair

     */

    IMPORT_C HBufC8* ExternalizeToDesLC() const;

    /**

     * Internalizes the pair from a stream

     *

     * @param aStream Source stream

     */

    IMPORT_C void InternalizeL( RReadStream& aStream );

private: // Construction & assignment

    /**

     * Private 2nd phase constructor.

     */

    void ConstructL( const TDesC& aKey, const TDesC& aValue );

    /**

     * Private constructor.

     */

    CNcdKeyValuePair();

private: // Data members

    // Key of the pair

    HBufC* iKey;

    // Value of the pair

    HBufC* iValue;

    };

/**

 *  A default implementation for the MNcdPurchaseDownloadInfo interface.

 *

 *  @lib ncdutils_20019119.dll

 *  

 *  @see MNcdPurchaseDownloadInfo

 */

class CNcdPurchaseDownloadInfo : public CBase,

                                 public MNcdPurchaseDownloadInfo

    {

public: // construction and destruction

    /**

     * Constructor.

     * 

     * 

     * @return Download information class.

     */

    IMPORT_C static CNcdPurchaseDownloadInfo* NewL();

    /**

     * Constructor.

     * 

     * 

     * @return Download information class.

     */

    IMPORT_C static CNcdPurchaseDownloadInfo* NewLC();

    /**

     * Copies and returns new download information.

     * 

     * 

     * @param aSource Download information to be copied.

     * @return Download information class.

     */

    IMPORT_C static CNcdPurchaseDownloadInfo* NewL( 

        const MNcdPurchaseDownloadInfo& aSource );

    /**

     * Copies and returns new download information.

     * 

     * 

     * @param aSource Download information to be copied.

     * @return Download information class.

     */

    IMPORT_C static CNcdPurchaseDownloadInfo* NewLC(

        const MNcdPurchaseDownloadInfo& aSource );

    /**

     * Destructor.

     * Because a class object outside of this library may be inherited 

     * from this class, this virtual destructor is also set to 

     * IMPORT_C.

     */

    IMPORT_C virtual ~CNcdPurchaseDownloadInfo();

public: // from MNcdPurchaseDownloadInfo

    /**

     * Gets the content usage type.

     * 

     * 

     * @return Content usage.

     */

    IMPORT_C TContentUsage ContentUsage() const;

    /**

     * Gets the content URI.

     * 

     * 

     * @return Content URI.

     */

    IMPORT_C const TDesC& ContentUri() const;

    /**

     * Gets the content validity delta.

     * 

     * 

     * @return Content validity delta. -1 if not set.

     */

    IMPORT_C TInt ContentValidityDelta() const;

    /**

     * Gets the content mime type.

     * 

     * 

     * @return Content mime type.

     */

    IMPORT_C const TDesC& ContentMimeType() const;

    /**

     * Gets the content size.

     * 

     * 

     * @return Content size.

     */

    IMPORT_C TInt ContentSize() const;

    /**

     * Is content launchable.

     * 

     * 

     * @return Launchable status.

     */

    IMPORT_C TBool IsLaunchable() const;

    /**

     * Gets the descriptor type.

     * 

     * 

     * @return Descriptor type.

     */

    IMPORT_C const TDesC& DescriptorType() const;

    /**

     * Gets the descriptor name.

     * 

     * 

     * @return Descriptor name.

     */

    IMPORT_C const TDesC& DescriptorName() const;

    /**

     * Gets the descriptor URI.

     * 

     * 

     * @return Descriptor URI.

     */

    IMPORT_C const TDesC& DescriptorUri() const;

    /**

     * Gets the descriptor data.

     * 

     * 

     * @return Descriptor data.

     */

    IMPORT_C const TDesC8& DescriptorData() const;

    /**

     * Gets the rights URI.

     * 

     * 

     * @return Rights URI.

     */

    IMPORT_C const TDesC& RightsUri() const;

    /**

     * Gets the rights type.

     * 

     * 

     * @return Rights type.

     */

    IMPORT_C const TDesC& RightsType() const;

    /**

     * Gets the activation key.

     *

     * 

     * @return Activation key.

     */

    IMPORT_C const TDesC& ActivationKey() const;

    /**

     * Gets the install notification URI.

     *

     * 

     * @return Install notification URI.

     */

    IMPORT_C const TDesC& InstallNotificationUri() const;

    /**

     * @see MNcdDownloadInfo::AttributeStringL

     */

    IMPORT_C const TDesC& AttributeStringL( TDownloadAttribute aAttribute ) const;

    /**

     * @see MNcdDownloadInfo::AttributeInt32L

     */

    IMPORT_C TInt32 AttributeInt32L( TDownloadAttribute aAttribute ) const;

public: // new methods

    /**

     * Externalizer.

     * 

     * 

     * @param aStream Write stream.

     */

    IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;

    /**

     * Internalizer.

     * 

     * 

     * @param aStream Read stream.

     */

    IMPORT_C void InternalizeL( RReadStream& aStream );

    /**

     * Sets the content usage type.

     * 

     * 

     * @param aUsage Content usage.

     */

    IMPORT_C void SetContentUsage( TContentUsage aUsage );

    /**

     * Sets the content URI.

     * 

     * 

     * @param aUri Content URI.

     */

    IMPORT_C void SetContentUriL( const TDesC& aUri );

    /**

     * Sets the content validity delta.

     * 

     * 

     * @return Content validity delta.

     */

    IMPORT_C void SetContentValidityDelta( TInt aValidityDelta );

    /**

     * Sets the content mime type.

     * 

     * 

     * @param aMimeType Content mime type.

     */

    IMPORT_C void SetContentMimeTypeL( const TDesC& aMimeType );

    /**

     * Sets the content size.

     * 

     * 

     * @param aSize Content size.

     */

    IMPORT_C void SetContentSize( TInt aSize );

    /**

     * Sets content launchable.

     * 

     * 

     * @param aLaunchable Launchable status.

     */

    IMPORT_C void SetLaunchable( TBool aLaunchable );

    /**

     * Sets the descriptor type.

     * 

     * 

     * @param aType Descriptor type.

     */

    IMPORT_C void SetDescriptorTypeL( const TDesC& aType );

    /**

     * Sets the descriptor name.

     * 

     * 

     * @param aName Descriptor name.

     */

    IMPORT_C void SetDescriptorNameL( const TDesC& aName );

    /**

     * Sets the descriptor URI.

     * 

     * 

     * @param aUri Descriptor URI.

     */

    IMPORT_C void SetDescriptorUriL( const TDesC& aUri );

    /**

     * Sets the descriptor data.

     * 

     * 

     * @param aData Descriptor data.

     */

    IMPORT_C void SetDescriptorDataL( const TDesC8& aData );

    /**

     * Sets the rights URI.

     * 

     * 

     * @param aUri Rights URI.

     */

    IMPORT_C void SetRightsUriL( const TDesC& aUri );

    /**

     * Sets the rights type.

     * 

     * 

     * @param aType Rights type.

     */

    IMPORT_C void SetRightsTypeL( const TDesC& aType );

    /**

     * Sets the activation key.

     * 

     * 

     * @param aActivationKey Activation key.

     */

    IMPORT_C void SetActivationKeyL( const TDesC& aActivationKey );

    /**

     * Sets the install notification URI.

     * 

     * 

     * @param aInstallNotificationUri Install notification URI.

     */

    IMPORT_C void SetInstallNotificationUriL( const TDesC& aInstallNotificationUri );