voipplugins/voipadapters/voipxmlprovisioning/voipxmlprocessor/inc/voipxmlxdmhandler.h
changeset 2 7b872347d83b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/voipplugins/voipadapters/voipxmlprovisioning/voipxmlprocessor/inc/voipxmlxdmhandler.h	Tue Feb 02 00:05:57 2010 +0200
@@ -0,0 +1,120 @@
+/*
+* Copyright (c) 2009-2010 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:  XDM handler for VoIP XML processor
+*
+*/
+
+
+#ifndef  VOIPXMLXDMHANDLER_H
+#define  VOIPXMLXDMHANDLER_H
+
+
+class CXdmSettingsCollection;
+
+/**
+*  VoipXmlXdmHandler
+*  XDM handler class.
+* 
+*  @lib voipxmlprocessor.lib
+*  @since S60 v5.0
+*/
+class CVoipXmlXdmHandler : public CBase
+    {
+#ifdef _DEBUG
+    friend class UT_CVoipXmlXdmHandler;
+    friend class UT_CVoipXmlParamHandler;
+#endif
+
+public:
+
+    static CVoipXmlXdmHandler* NewL();
+    ~CVoipXmlXdmHandler();
+
+public:
+
+    /**
+     * Sets XDM setting.
+     *
+     * @since S60 v5.0
+     * @param aParam Parameter to be set.
+     * @param aValue Value of the setting.
+     */
+    void SetSetting( TInt aParam, const TDesC& aValue );
+
+    /**
+     * Stores settings to 'XDM registry', i.e. creates an XDM collection.
+     *
+     * @since S60 v5.0
+     * @return KErrNone if successful,
+     *         KErrNotSupported if no settings to be stored,
+     *         KErrCompletion if settings could not be stored.
+     */
+    TInt StoreSettings();
+
+    /**
+     * Returns the settings ID.
+     *
+     * @since S60 v5.0
+     * @return XDM settings ID.
+     */
+    TUint32 SettingsId();
+
+private:
+
+    /**
+     * Sets XDM setting.
+     *
+     * @since S60 v5.0
+     * @param aParam Parameter to be set.
+     * @param aValue Value of the setting.
+     */
+    void SetSettingL( TInt aParam, const TDesC& aValue );
+
+    /**
+     * Creates a provider name for XDM profile. aName is used
+     * and replaced with a parenthised ordered number if the name is
+     * already found in XDM storage.
+     *
+     * @since S60 v5.0
+     * @param aName Provider name to be set.
+     */
+    void CreateProviderNameL( TDes& aName );
+
+private:
+
+    CVoipXmlXdmHandler();
+    void ConstructL();
+
+private:
+
+    /**
+     * XDM settings collection object.
+     * Own.
+     */
+    CXdmSettingsCollection* iProfile;
+
+    /**
+     * Tells if any settings have been set to temporary profile.
+     */
+    TBool iSettingsSet;
+
+    /**
+     * XDM collection ID.
+     */
+    TUint32 iProfileId;
+    };
+
+#endif // VOIPXMLXDMHANDLER_H
+
+// End of file.