contentstorage/cautils/inc/cainnernotifierfilter.h
author hgs
Mon, 20 Sep 2010 10:22:22 +0300
changeset 119 50e220be30d1
parent 85 7feec50967db
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     1
/*
7feec50967db 201003_02
hgs
parents:
diff changeset
     2
 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
7feec50967db 201003_02
hgs
parents:
diff changeset
     3
 * All rights reserved.
7feec50967db 201003_02
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
7feec50967db 201003_02
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
7feec50967db 201003_02
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
7feec50967db 201003_02
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
7feec50967db 201003_02
hgs
parents:
diff changeset
     8
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
     9
 * Initial Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
7feec50967db 201003_02
hgs
parents:
diff changeset
    11
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    12
 * Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    13
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    14
 * Description:  ?Description
7feec50967db 201003_02
hgs
parents:
diff changeset
    15
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    16
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    17
7feec50967db 201003_02
hgs
parents:
diff changeset
    18
#ifndef CAINNERNOTIFIERFILTER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define CAINNERNOTIFIERFILTER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
#include <e32base.h>
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
#include "cadef.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
class CDesC16ArrayFlat;
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
class RWriteStream;
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
class RReadStream;
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
 * Class represents Notifier filter
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
NONSHARABLE_CLASS( CCaInnerNotifierFilter ): public CBase
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
    {
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
    enum TNotifierType
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
        {
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
        EEntryChangedWithId = 0,
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
        EEntryChangedWithEntry,
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
        EEntryTouched,
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
        EGroupContentChanged
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
        };
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
     * Destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
    virtual ~CCaInnerNotifierFilter();
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
     * Two-phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
     * @param aInnerNotifierType inner type of notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
     * @return The created object.
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
    IMPORT_C static CCaInnerNotifierFilter* NewL(
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
        TNotifierType aInnerNotifierType );
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
     * Two-phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
     * @param aInnerNotifierType inner type of notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
     * @return The created object.
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
    IMPORT_C static CCaInnerNotifierFilter* NewLC(
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
        TNotifierType aInnerNotifierType );
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
    IMPORT_C TInt GetParentId() const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    70
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
    IMPORT_C void SetParentId( TInt aParentId );
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
    IMPORT_C RArray<TInt> GetIds() const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    76
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
    IMPORT_C void SetIdsL( const RArray<TInt>& aIds );
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
    IMPORT_C TEntryRole GetEntryRole() const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    86
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    87
    IMPORT_C void SetEntryRole( TEntryRole aEntryRole );
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
    IMPORT_C CDesC16ArrayFlat* GetTypeNames() const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    95
    IMPORT_C void SetTypeNames( CDesC16ArrayFlat * aTypeNames );
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
    IMPORT_C TNotifierType GetNotifierType() const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   103
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
    IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
    IMPORT_C void InternalizeL( RReadStream& aStream );
7feec50967db 201003_02
hgs
parents:
diff changeset
   110
7feec50967db 201003_02
hgs
parents:
diff changeset
   111
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   112
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
     * Second phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
    void ConstructL();
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
7feec50967db 201003_02
hgs
parents:
diff changeset
   118
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
     * Constructor
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
    CCaInnerNotifierFilter( TNotifierType aInnerNotifierType );
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   126
     * Unique identifier of parent. Own
7feec50967db 201003_02
hgs
parents:
diff changeset
   127
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   128
    TInt iParentId;
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   130
     * Unique identifier of entries. Own
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
    RArray<TInt> iIds;
7feec50967db 201003_02
hgs
parents:
diff changeset
   133
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   135
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
    TEntryRole iEntryRole;
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   138
     * Own
7feec50967db 201003_02
hgs
parents:
diff changeset
   139
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
    CDesC16ArrayFlat* iTypeNames;
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   142
     * Notifier command
7feec50967db 201003_02
hgs
parents:
diff changeset
   143
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   144
    TNotifierType iNotifierType;
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
    };
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
7feec50967db 201003_02
hgs
parents:
diff changeset
   148
#endif // CAINNERNOTIFIERFILTER_H