contentstorage/castorage/inc/castorage.h
author hgs
Mon, 18 Oct 2010 10:44:15 +0300
changeset 127 7b66bc3c6dc9
parent 107 b34d53f6acdf
permissions -rw-r--r--
201041
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:
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 C_CASTORAGE_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define C_CASTORAGE_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
#include "caoperationparams.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
// FORWARD DECLARATIONS
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
class CCaInnerQuery;
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
class CCaInnerEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
class CCaLocalizationEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
 *  @ingroup group_catorage.
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
 *  Interface for storage.
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
class CCaStorage: 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
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
     * Localizes one entry attribute.
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
     * @param aLocalization localization information about entry.
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
    virtual void LocalizeEntryL( CCaLocalizationEntry& aLocalization ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
    /**
94
hgs
parents: 86
diff changeset
    43
     * Adds localization row to the localization table
hgs
parents: 86
diff changeset
    44
     *
hgs
parents: 86
diff changeset
    45
     * @param aLocalization localization information about entry.
hgs
parents: 86
diff changeset
    46
     */
hgs
parents: 86
diff changeset
    47
    virtual void AddLocalizationL( const CCaLocalizationEntry& aLocalization ) = 0;
127
hgs
parents: 107
diff changeset
    48
94
hgs
parents: 86
diff changeset
    49
    /**
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
     * Fetches data from database
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
     * @param aResultContainer container for localizations information.
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
    virtual void GetLocalizationsL( RPointerArray<CCaLocalizationEntry>& aResultContainer ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
     * Fetches data from database.
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
     * @param aQuery The query information to select specific entries.
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
     * @param aResultContainer The result list of entries .
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
     * for a specific select.
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
     */
86
hgs
parents: 85
diff changeset
    63
    virtual void GetEntriesL( const CCaInnerQuery* aQuery,
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
            RPointerArray<CCaInnerEntry>& aResultContainer ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
     * Fetches data from database by ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
     * @param aQuery The query information to select specific entries.
86
hgs
parents: 85
diff changeset
    70
     * @param aResultIdArray The result list of entries' ids.
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
     * for a specific select.
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
    virtual void GetEntriesIdsL( const CCaInnerQuery* aQuery,
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
            RArray<TInt>& aResultIdArray ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
7feec50967db 201003_02
hgs
parents:
diff changeset
    76
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
     * Fetches parent id from database by entry ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
     * @param aEntryIdArray list of enties ids.
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
     * @param aParentIdArray The result list of parents' ids
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     * for a specific select.
127
hgs
parents: 107
diff changeset
    82
     * @param aCheckParentsParent flag if set to true then
hgs
parents: 107
diff changeset
    83
     * search also for parent of the parent
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
     */
86
hgs
parents: 85
diff changeset
    85
    virtual void GetParentsIdsL( const RArray<TInt>& aEntryIdArray,
127
hgs
parents: 107
diff changeset
    86
            RArray<TInt>& aParentIdArray,
98
hgs
parents: 94
diff changeset
    87
            TBool aCheckParentsParent = ETrue ) = 0;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
     * Adds or Updates data & action to the storage.
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
     * @param aEntry The entry data to be added or updated.
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
    virtual void AddL( CCaInnerEntry* aEntry, TBool aUpdate = EFalse ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
    95
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
     * Removes data item from storage.
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
     * @param aEntryIds The entry ids to be removed.
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
    virtual void RemoveL( const RArray<TInt>& aEntryIds ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
7feec50967db 201003_02
hgs
parents:
diff changeset
   103
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
     * Organizes data within a group in the storage.
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
     * @param aEntryIds Ids of entries to organize.
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
     * @param aParams Operation parameters to specify the organize type.
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
    virtual void OrganizeL( const RArray<TInt>& aEntryIds,
7feec50967db 201003_02
hgs
parents:
diff changeset
   110
            TCaOperationParams aParams ) = 0;
7feec50967db 201003_02
hgs
parents:
diff changeset
   111
7feec50967db 201003_02
hgs
parents:
diff changeset
   112
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
     * Stores touch data information in storage.
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
     * @param aEntryId The entry id for which touch data should be stored.
107
hgs
parents: 99
diff changeset
   116
     * @param aRemovable if entry is removable then flag is set if necessary.
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
     */
107
hgs
parents: 99
diff changeset
   118
    virtual void TouchL( const TInt aEntryId, TBool aRemovable ) = 0;
86
hgs
parents: 85
diff changeset
   119
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
     * Get database property from db.
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
     * @param aProperty The property to get.
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
     * @param aPropertyValue The value of property.
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   126
    virtual void DbPropertyL( const TDesC& aProperty, TDes& aPropertyValue ) = 0;
86
hgs
parents: 85
diff changeset
   127
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   128
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
     * Set property .
7feec50967db 201003_02
hgs
parents:
diff changeset
   130
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
     * @param aProperty The property to set.
7feec50967db 201003_02
hgs
parents:
diff changeset
   132
     * @param aPropertyValue The value of property.
7feec50967db 201003_02
hgs
parents:
diff changeset
   133
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   134
    virtual void SetDBPropertyL( const TDesC& aProperty, const TDesC& aPropertyValue ) = 0;
86
hgs
parents: 85
diff changeset
   135
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   136
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   137
     * Remove from localization table .
7feec50967db 201003_02
hgs
parents:
diff changeset
   138
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   139
     * @param aEntryId Entry Id to remove.
7feec50967db 201003_02
hgs
parents:
diff changeset
   140
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   141
    virtual void RemoveFromLocalizationL( const TInt aEntryId ) = 0;
86
hgs
parents: 85
diff changeset
   142
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   143
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   144
     * Organizes data within a group in custom order.
7feec50967db 201003_02
hgs
parents:
diff changeset
   145
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   146
     * @param aEntryIds Ids of entries in custom order.
7feec50967db 201003_02
hgs
parents:
diff changeset
   147
     * @param aGroupId Group to sort.
7feec50967db 201003_02
hgs
parents:
diff changeset
   148
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   149
    virtual void CustomSortL( const RArray<TInt>& aEntryIds,
86
hgs
parents: 85
diff changeset
   150
            const TInt aGroupId ) = 0;
hgs
parents: 85
diff changeset
   151
107
hgs
parents: 99
diff changeset
   152
    /**
hgs
parents: 99
diff changeset
   153
     * Saves a copy of database to private.
hgs
parents: 99
diff changeset
   154
     */
hgs
parents: 99
diff changeset
   155
    virtual void SaveDatabaseL() = 0;
127
hgs
parents: 107
diff changeset
   156
86
hgs
parents: 85
diff changeset
   157
    /**
hgs
parents: 85
diff changeset
   158
     * Loads data base from rom.
hgs
parents: 85
diff changeset
   159
     */
hgs
parents: 85
diff changeset
   160
    virtual void LoadDataBaseFromRomL() = 0;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   161
7feec50967db 201003_02
hgs
parents:
diff changeset
   162
    };
7feec50967db 201003_02
hgs
parents:
diff changeset
   163
7feec50967db 201003_02
hgs
parents:
diff changeset
   164
#endif //C_CASTORAGE_H