1 /*

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

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:   Definition of purchase history filter interface and

    15 *                implementation class.

    16 *

    17 */

    18 

    19 

    20 #ifndef M_NCD_PURCHASE_HISTORY_FILTER_H

    21 #define M_NCD_PURCHASE_HISTORY_FILTER_H

    22 

    23 #include <e32base.h>

    24 

    25 #include "catalogsbase.h"

    26 

    27 /**

    28  *  Purchase history filter interface.

    29  *

    30  *  Allows setting of client uid(s), entity namespace and id, and event id

    31  *  for filtering purchase history information.

    32  *

    33  *  

    34  *  @see MNcdPurchaseHistory::PurchaseIdsL()

    35  */

    36 

    37 class MNcdPurchaseHistoryFilter

    38     {

    39 

    40 public:

    41     

    42     /**

    43      * Get client UIDs used in this filter. Purchase events have client UID to

    44      * indicate the creator of the event.

    45      *

    46      * 

    47      * @return Array of client UIDs. If empty, all client UIDs match.

    48      */

    49     virtual const TArray< TUid > ClientUids() const = 0;

    50 

    51 

    52     /**

    53      * Get the namespace used in this filter.

    54      *

    55      * 

    56      * @return Namespace. If empty string, all namespaces match.

    57      */

    58     virtual const TDesC& Namespace() const = 0;

    59 

    60 

    61     /**

    62      * Get entity ID used in this filter.

    63      *

    64      * 

    65      * @return Entity ID. If empty string, all entity ids match.

    66      */

    67     virtual const TDesC& EntityId() const = 0;

    68 

    69     /**

    70      * Get event ID used in this filter.

    71      *

    72      * 

    73      * @return Event ID. Only purchases with a larger event id will match. 

    74      */

    75     virtual TUint EventId() const = 0;

    76 

    77     };

    78 

    79 

    80 #endif // M_NCD_PURCHASE_HISTORY_FILTER_H