deviceupdatesui/deviceupdates/inc/nsmldmsyncprofilelist.h
author hgs
Fri, 19 Mar 2010 04:28:07 +0530
changeset 33 7464c1e21dae
child 36 9eefb50e711a
permissions -rw-r--r--
201008_internal
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     1
/*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     2
* Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     3
* All rights reserved.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     8
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     9
* Initial Contributors:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    11
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    12
* Contributors:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    13
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    14
* Description:  Profile list container
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    15
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    16
*/
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    17
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    18
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    19
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    20
#ifndef CNSMLDMSYNCPROFILELIST_H
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    21
#define CNSMLDMSYNCPROFILELIST_H
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    22
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    23
//  INCLUDES
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    24
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    25
#include <e32base.h>
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    26
#include "NSmlDMSyncProfileItem.h"
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    27
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    28
// FORWARD DECLARATIONS
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    29
class TNSmlDMSyncProfileItem;
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    30
class CNSmlDMSyncProfile;
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    31
class CNSmlDMSyncAppEngine;
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    32
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    33
/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    34
* CNSmlDMSyncProfileList 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    35
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    36
* CNSmlDMSyncProfileList is a list of profiles
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    37
*/
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    38
NONSHARABLE_CLASS (CNSmlDMSyncProfileList) : public CBase
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    39
    {
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    40
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    41
    public:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    42
        /**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    43
        * Two-phased constructor.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    44
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    45
        static CNSmlDMSyncProfileList* NewL( CNSmlDMSyncAppEngine* aEngine  );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    46
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    47
	    /**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    48
        * Destructor.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    49
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    50
        virtual ~CNSmlDMSyncProfileList();
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    51
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    52
    private:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    53
        /**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    54
        * C++ default constructor.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    55
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    56
	    CNSmlDMSyncProfileList( CNSmlDMSyncAppEngine* aEngine  );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    57
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    58
        /**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    59
        * By default Symbian 2nd phase constructor is private.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    60
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    61
	    void ConstructL();
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    62
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    63
	public:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    64
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    65
		* Returns profile count.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    66
        * @return Profile count.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    67
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    68
		TInt Count();
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    69
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    70
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    71
		* Returns profile from list.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    72
        * @param aIndex List index.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    73
		* @return TNSmlDMSyncProfileItem.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    74
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    75
		TNSmlDMSyncProfileItem Item( TInt aIndex );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    76
	
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    77
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    78
		* Finds profile with name aProfileName.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    79
		* @param aProfileName Profile name.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    80
		* @return Profile id or KErrNotFound.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    81
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    82
		TInt FindProfile( const TDesC& aProfileName );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    83
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    84
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    85
		* Read one profile from database.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    86
		* @param aProfile.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    87
		* @return TNSmlDMSyncProfileItem.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    88
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    89
        TNSmlDMSyncProfileItem ReadProfileItemL( CNSmlDMSyncProfile* aProfile );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    90
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    91
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    92
		* Reads all profiles from database.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    93
		* @return None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    94
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    95
		void ReadProfileItemsL();
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    96
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    97
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    98
		* Reads all profiles from database.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    99
		* @param aIncludeHidden Should hidden profile be included
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   100
		* @return None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   101
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   102
		void ReadProfileItemsL( TBool aIncludeHidden );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   103
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   104
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   105
		* Reads one profile from database.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   106
		* @param aIndex profile index
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   107
		* @return None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   108
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   109
		void ReadProfileItemL( TInt aIndex );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   110
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   111
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   112
		* Resets profile list.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   113
		* @param None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   114
		* @return None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   115
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   116
		void Reset();
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   117
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   118
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   119
		* Remove item from profilelist
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   120
		* @param aProfileId.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   121
		* @return None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   122
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   123
		void Remove( TInt aProfileId );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   124
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   125
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   126
		* Checks that mandatory data exists.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   127
		* @param aProfile.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   128
		* @return Return code.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   129
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   130
        static TInt CheckMandatoryDataL( CNSmlDMSyncProfile* aProfile );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   131
		
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   132
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   133
		* Replaces profile items
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   134
		* @param aProfileItem.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   135
		* @return None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   136
        */	
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   137
		void ReplaceProfileItemL( TNSmlDMSyncProfileItem& aProfileItem );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   138
		
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   139
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   140
		* Sort list
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   141
		* @param None
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   142
		* @return None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   143
        */		
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   144
		void Sort();
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   145
				
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   146
	private:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   147
		
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   148
		/**
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   149
		* Chceks empty characters
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   150
		* @param aText
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   151
		* @return ETrue if text is empty
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   152
        */
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   153
		static TBool IsEmpty( const TDesC& aText );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   154
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   155
	private:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   156
	    // Sync app engine
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   157
        CNSmlDMSyncAppEngine*           iEngine;
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   158
		// list of profiles
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   159
		RArray<TNSmlDMSyncProfileItem>  iList;
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   160
    };
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   161
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   162
#endif  // CNSMLDMSYNCPROFILELIST_H
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   163
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   164
// End of File