--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/ncdengine/provider/server/inc/ncdnodedisclaimer.h Thu Dec 17 08:51:10 2009 +0200
@@ -0,0 +1,232 @@
+/*
+* Copyright (c) 2006 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: Contains CNcdNodeDisclaimer class
+*
+*/
+
+
+#ifndef NCD_NODE_DISCLAIMER_H
+#define NCD_NODE_DISCLAIMER_H
+
+
+// For streams
+#include <s32mem.h>
+
+#include "ncdcommunicable.h"
+#include "ncdstoragedataitem.h"
+#include "ncdnodeclassids.h"
+#include "ncdprotocoltypes.h"
+#include "ncd_cp_query.h"
+
+
+/**
+ * This server side class contains the data and the functionality
+ * that the proxy objects will use to internalize itself.
+ *
+ * This object should be added to the session. So, it will be usable
+ * in the proxy side by using the handle gotten during addition.
+ * The handle is used to identify to what object the proxy directs
+ * the function call. When objects are added to sessions,
+ * multiple handles may be gotten for the same object if addition is
+ * done multiple times.
+ *
+ * @lib ?library
+ * @since S60 ?S60_version *** for example, S60 v3.0
+ */
+class CNcdNodeDisclaimer : public CNcdCommunicable,
+ public MNcdStorageDataItem
+ {
+
+public:
+ /**
+ * NewL
+ *
+ * @return CNcdNodeDisclaimer* Pointer to the created object
+ * of this class.
+ */
+ static CNcdNodeDisclaimer* NewL();
+
+ /**
+ * NewLC
+ *
+ * @return CNcdNodeDisclaimer* Pointer to the created object
+ * of this class.
+ */
+ static CNcdNodeDisclaimer* NewLC();
+
+ /**
+ * NewL.
+ *
+ * Copies the given disclaimer. Note, base class variables are not copied.
+ *
+ * @param aDisclaimer The disclaimer to copy.
+ */
+ static CNcdNodeDisclaimer* NewL( const CNcdNodeDisclaimer& aDisclaimer );
+
+ /**
+ * NewLC.
+ *
+ * Copies the given disclaimer. Note, base class variables are not copied.
+ *
+ * @param aDisclaimer The disclaimer to copy.
+ */
+ static CNcdNodeDisclaimer* NewLC( const CNcdNodeDisclaimer& aDisclaimer );
+
+
+ /**
+ * Destructor
+ *
+ * @note Because this is CCatalogsCommunicable function the
+ * session that owns this object should delete this class object.
+ * So, instead of directly deleting this object from some other
+ * class. Close-method should be used instead.
+ */
+ virtual ~CNcdNodeDisclaimer();
+
+
+ /**
+ * Retrieves the data type that informs what class the data is for.
+ * By checking the data type information, an InternalizeL function
+ * of a right class can be called when the object data is set
+ * from the storage.
+ * The data type may be decided and set in a object that creates this
+ * class object.
+ *
+ * @return NcdNodeClassIds::TNcdNodeClassId Describes the data type.
+ */
+ NcdNodeClassIds::TNcdNodeClassId ClassId() const;
+
+
+ /**
+ * This function is called when the owner of this object
+ * wants to internalize the content according to the data
+ * that has been received from the parser.
+ *
+ * @param aData The data is set in the protocol parser and can
+ * be used to initialize this class object.
+ */
+ void InternalizeL( const MNcdConfigurationProtocolQuery& aData );
+
+
+public: // MNcdStorageDataItem
+
+ // These functions are used to get the data from and to insert the data
+ // into the database using by the given stream.
+
+ /**
+ * @see MNcdStorageDataItem::ExternalizeL
+ */
+ virtual void ExternalizeL( RWriteStream& aStream );
+
+
+ /**
+ * @see MNcdStorageDataItem::InternalizeL
+ */
+ virtual void InternalizeL( RReadStream& aStream );
+
+
+public: // CCatalogsCommunicable
+
+ /**
+ * @see CCatalogsCommunicable::ReceiveMessage
+ */
+ virtual void ReceiveMessage( MCatalogsBaseMessage* aMessage,
+ TInt aFunctionNumber );
+
+ /**
+ * @see CCatalogsCommunicable::CounterPartLost
+ */
+ virtual void CounterPartLost( const MCatalogsSession& aSession );
+
+
+protected:
+
+ /**
+ * Constructor
+ * @param aClassId Identifies this class.
+ * Is set in the NewLC function
+ */
+ CNcdNodeDisclaimer( NcdNodeClassIds::TNcdNodeClassId aClassId );
+
+ /**
+ * ConstructL
+ */
+ virtual void ConstructL();
+
+ /**
+ * ConstructL
+ */
+ virtual void ConstructL( const CNcdNodeDisclaimer& aDisclaimer );
+
+
+ // These functions are called from the ReceiveMessage when
+ // the given function id has matched to the function.
+
+ /**
+ * This function is called when the proxy wants to get the
+ * data from the serverside. This function calls the
+ * InternalizeDataForRequestL which may be overloaded in the
+ * child classes
+ * @param aMessage Contains data from the proxy and can be used
+ * to send data back to proxy
+ */
+ void InternalizeRequestL( MCatalogsBaseMessage& aMessage );
+
+ /**
+ * This function writes the object data to the stream.
+ * The stream content will be sent to the proxy that requested the data.
+ * Child classes should add their own data after this parent data.
+ * @param aStream The data content of this class object will be written
+ * into this stream.
+ */
+ virtual void ExternalizeDataForRequestL( RWriteStream& aStream );
+
+ /**
+ * This function is called from the proxy side. When the proxy
+ * is deleted.
+ * @param aMessage Contains data from the proxy and can be used
+ * to send data back to proxy
+ */
+ void ReleaseRequest( MCatalogsBaseMessage& aMessage ) const;
+
+
+private:
+
+ // Prevent these two if they are not implemented
+ CNcdNodeDisclaimer( const CNcdNodeDisclaimer& aObject );
+ CNcdNodeDisclaimer& operator =( const CNcdNodeDisclaimer& aObject );
+
+
+private: // data
+
+ // The class id is identifies this class. The id may be used to
+ // identify what kind of class object is created when data is gotten
+ // from the db.
+ NcdNodeClassIds::TNcdNodeClassId iClassId;
+
+ // The message is set when ReceiveMessage is called. The message
+ // is used in the CounterPartLost-function that informs the message
+ // if the session has been lost.
+ MCatalogsBaseMessage* iMessage;
+
+
+ // Disclaimer content
+ HBufC* iTitle;
+ HBufC* iBodyText;
+ TBool iOptional;
+ MNcdQuery::TSemantics iSemantics;
+
+ };
+
+#endif // NCD_NODE_DISCLAIMER_H